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 /******************************************************************************/
513 * Get priority for a queued message.
515 * @param q Queued message
517 * @return CORE priority to use.
519 static enum GNUNET_CORE_Priority
520 get_priority (struct MeshPeerQueue *q)
522 enum GNUNET_CORE_Priority low;
523 enum GNUNET_CORE_Priority high;
528 return GNUNET_CORE_PRIO_BACKGROUND;
531 /* Relayed traffic has lower priority, our own traffic has higher */
532 if (NULL == q->c || GNUNET_NO == GMC_is_origin (q->c, q->fwd))
534 low = GNUNET_CORE_PRIO_BEST_EFFORT;
535 high = GNUNET_CORE_PRIO_URGENT;
539 low = GNUNET_CORE_PRIO_URGENT;
540 high = GNUNET_CORE_PRIO_CRITICAL_CONTROL;
543 /* Bulky payload has lower priority, control traffic has higher. */
544 if (GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED == q->type)
552 * Iterator over tunnel hash map entries to destroy the tunnel during shutdown.
555 * @param key current key code
556 * @param value value in the hash map
557 * @return #GNUNET_YES if we should continue to iterate,
561 shutdown_tunnel (void *cls,
562 const struct GNUNET_PeerIdentity *key,
565 struct MeshPeer *p = value;
566 struct MeshTunnel3 *t = p->tunnel;
575 * Destroy the peer_info and free any allocated resources linked to it
577 * @param peer The peer_info to destroy.
579 * @return GNUNET_OK on success
582 peer_destroy (struct MeshPeer *peer)
584 struct GNUNET_PeerIdentity id;
585 struct MeshPeerPath *p;
586 struct MeshPeerPath *nextp;
588 GNUNET_PEER_resolve (peer->id, &id);
589 GNUNET_PEER_change_rc (peer->id, -1);
591 LOG (GNUNET_ERROR_TYPE_WARNING, "destroying peer %s\n", GNUNET_i2s (&id));
594 GNUNET_CONTAINER_multipeermap_remove (peers, &id, peer))
597 LOG (GNUNET_ERROR_TYPE_WARNING, " not in peermap!!\n");
599 if (NULL != peer->search_h)
601 GMD_search_stop (peer->search_h);
607 GNUNET_CONTAINER_DLL_remove (peer->path_head, peer->path_tail, p);
611 GMT_destroy_empty (peer->tunnel);
618 * Returns if peer is used (has a tunnel or is neighbor).
620 * @param peer Peer to check.
622 * @return #GNUNET_YES if peer is in use.
625 peer_is_used (struct MeshPeer *peer)
627 struct MeshPeerPath *p;
629 if (NULL != peer->tunnel)
632 for (p = peer->path_head; NULL != p; p = p->next)
642 * Iterator over all the peers to get the oldest timestamp.
644 * @param cls Closure (unsued).
645 * @param key ID of the peer.
646 * @param value Peer_Info of the peer.
649 peer_get_oldest (void *cls,
650 const struct GNUNET_PeerIdentity *key,
653 struct MeshPeer *p = value;
654 struct GNUNET_TIME_Absolute *abs = cls;
656 /* Don't count active peers */
657 if (GNUNET_YES == peer_is_used (p))
660 if (abs->abs_value_us < p->last_contact.abs_value_us)
661 abs->abs_value_us = p->last_contact.abs_value_us;
668 * Iterator over all the peers to remove the oldest entry.
670 * @param cls Closure (unsued).
671 * @param key ID of the peer.
672 * @param value Peer_Info of the peer.
675 peer_timeout (void *cls,
676 const struct GNUNET_PeerIdentity *key,
679 struct MeshPeer *p = value;
680 struct GNUNET_TIME_Absolute *abs = cls;
682 LOG (GNUNET_ERROR_TYPE_WARNING,
683 "peer %s timeout\n", GNUNET_i2s (key));
685 if (p->last_contact.abs_value_us == abs->abs_value_us &&
686 GNUNET_NO == peer_is_used (p))
696 * Delete oldest unused peer.
699 peer_delete_oldest (void)
701 struct GNUNET_TIME_Absolute abs;
703 abs = GNUNET_TIME_UNIT_FOREVER_ABS;
705 GNUNET_CONTAINER_multipeermap_iterate (peers,
708 GNUNET_CONTAINER_multipeermap_iterate (peers,
715 * Choose the best (yet unused) path towards a peer,
716 * considering the tunnel properties.
718 * @param peer The destination peer.
720 * @return Best current known path towards the peer, if any.
722 static struct MeshPeerPath *
723 peer_get_best_path (const struct MeshPeer *peer)
725 struct MeshPeerPath *best_p;
726 struct MeshPeerPath *p;
727 unsigned int best_cost;
730 best_cost = UINT_MAX;
732 for (p = peer->path_head; NULL != p; p = p->next)
734 if (GNUNET_YES == GMT_is_path_used (peer->tunnel, p))
735 continue; /* If path is already in use, skip it. */
737 if (GNUNET_NO == path_is_valid (p))
738 continue; /* Don't use invalid paths. */
740 if ((cost = GMT_get_path_cost (peer->tunnel, p)) < best_cost)
751 queue_is_sendable (struct MeshPeerQueue *q)
753 /* Is PID-independent? */
756 case GNUNET_MESSAGE_TYPE_MESH_ACK:
757 case GNUNET_MESSAGE_TYPE_MESH_POLL:
758 case GNUNET_MESSAGE_TYPE_MESH_KX:
759 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE:
760 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK:
761 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY:
762 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN:
763 case GNUNET_MESSAGE_TYPE_MESH_KEEPALIVE:
766 case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
773 if (GMC_is_sendable (q->c, q->fwd))
781 * Get first sendable message.
783 * @param peer The destination peer.
785 * @return Best current known path towards the peer, if any.
787 static struct MeshPeerQueue *
788 peer_get_first_message (const struct MeshPeer *peer)
790 struct MeshPeerQueue *q;
792 for (q = peer->queue_head; NULL != q; q = q->next)
794 if (queue_is_sendable (q))
803 * Function to process paths received for a new peer addition. The recorded
804 * paths form the initial tunnel, which can be optimized later.
805 * Called on each result obtained for the DHT search.
811 search_handler (void *cls, const struct MeshPeerPath *path)
813 struct MeshPeer *peer = cls;
814 unsigned int connection_count;
816 GMP_add_path_to_all (path, GNUNET_NO);
818 /* Count connections */
819 connection_count = GMT_count_connections (peer->tunnel);
821 /* If we already have 3 (or more (?!)) connections, it's enough */
822 if (3 <= connection_count)
825 if (MESH_TUNNEL3_SEARCHING == GMT_get_cstate (peer->tunnel))
827 LOG (GNUNET_ERROR_TYPE_DEBUG, " ... connect!\n");
836 * Core callback to write a queued packet to core buffer
838 * @param cls Closure (peer info).
839 * @param size Number of bytes available in buf.
840 * @param buf Where the to write the message.
842 * @return number of bytes written to buf
845 queue_send (void *cls, size_t size, void *buf)
847 struct MeshPeer *peer = cls;
848 struct MeshConnection *c;
849 struct MeshPeerQueue *queue;
850 const struct GNUNET_PeerIdentity *dst_id;
853 peer->core_transmit = NULL;
854 LOG (GNUNET_ERROR_TYPE_DEBUG, "* Queue send towards %s (max %u)\n",
855 GMP_2s (peer), size);
857 if (NULL == buf || 0 == size)
859 LOG (GNUNET_ERROR_TYPE_DEBUG, "* Buffer size 0.\n");
864 queue = peer_get_first_message (peer);
867 GNUNET_break (0); /* Core tmt_rdy should've been canceled */
872 dst_id = GNUNET_PEER_resolve2 (peer->id);
873 LOG (GNUNET_ERROR_TYPE_DEBUG, "* on connection %s\n", GMC_2s (c));
874 /* Check if buffer size is enough for the message */
875 if (queue->size > size)
877 LOG (GNUNET_ERROR_TYPE_DEBUG, "* not enough room, reissue\n");
878 peer->core_transmit =
879 GNUNET_CORE_notify_transmit_ready (core_handle,
880 GNUNET_NO, get_priority (queue),
881 GNUNET_TIME_UNIT_FOREVER_REL,
888 LOG (GNUNET_ERROR_TYPE_DEBUG, "* size %u ok\n", queue->size);
893 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY:
894 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN:
895 case GNUNET_MESSAGE_TYPE_MESH_KEEPALIVE:
896 case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
897 case GNUNET_MESSAGE_TYPE_MESH_KX:
898 case GNUNET_MESSAGE_TYPE_MESH_ACK:
899 case GNUNET_MESSAGE_TYPE_MESH_POLL:
900 LOG (GNUNET_ERROR_TYPE_DEBUG, "* raw: %s\n", GM_m2s (queue->type));
901 data_size = send_core_data_raw (queue->cls, size, buf);
903 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE:
904 LOG (GNUNET_ERROR_TYPE_DEBUG, "* path create\n");
905 if (GMC_is_origin (c, GNUNET_YES))
906 data_size = send_core_connection_create (queue->c, size, buf);
908 data_size = send_core_data_raw (queue->cls, size, buf);
910 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK:
911 LOG (GNUNET_ERROR_TYPE_DEBUG, "* path ack\n");
912 if (GMC_is_origin (c, GNUNET_NO) ||
913 GMC_is_origin (c, GNUNET_YES))
914 data_size = send_core_connection_ack (queue->c, size, buf);
916 data_size = send_core_data_raw (queue->cls, size, buf);
918 case GNUNET_MESSAGE_TYPE_MESH_DATA:
919 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE:
920 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY:
921 /* This should be encapsulted */
927 LOG (GNUNET_ERROR_TYPE_WARNING, "* type unknown: %u\n", queue->type);
931 if (0 < drop_percent &&
932 GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 101) < drop_percent)
934 LOG (GNUNET_ERROR_TYPE_WARNING,
935 "Dropping message of type %s\n",
936 GM_m2s (queue->type));
940 /* Free queue, but cls was freed by send_core_* */
941 GMP_queue_destroy (queue, GNUNET_NO);
943 /* If more data in queue, send next */
944 queue = peer_get_first_message (peer);
947 LOG (GNUNET_ERROR_TYPE_DEBUG, "* more data!\n");
948 if (NULL == peer->core_transmit)
950 peer->core_transmit =
951 GNUNET_CORE_notify_transmit_ready (core_handle,
952 GNUNET_NO, get_priority (queue),
953 GNUNET_TIME_UNIT_FOREVER_REL,
958 queue->start_waiting = GNUNET_TIME_absolute_get ();
962 LOG (GNUNET_ERROR_TYPE_DEBUG,
963 "* tmt rdy called somewhere else\n");
965 // GMC_start_poll (); FIXME needed?
969 // GMC_stop_poll(); FIXME needed?
972 LOG (GNUNET_ERROR_TYPE_DEBUG, "* Return %d\n", data_size);
977 /******************************************************************************/
978 /******************************** API ***********************************/
979 /******************************************************************************/
983 * Free a transmission that was already queued with all resources
984 * associated to the request.
986 * @param queue Queue handler to cancel.
987 * @param clear_cls Is it necessary to free associated cls?
990 GMP_queue_destroy (struct MeshPeerQueue *queue, int clear_cls)
992 struct MeshPeer *peer;
996 if (GNUNET_YES == clear_cls)
998 LOG (GNUNET_ERROR_TYPE_DEBUG, "# queue destroy type %s\n",
999 GM_m2s (queue->type));
1000 switch (queue->type)
1002 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY:
1003 LOG (GNUNET_ERROR_TYPE_INFO, "destroying a DESTROY message\n");
1005 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK:
1006 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE:
1007 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN:
1008 case GNUNET_MESSAGE_TYPE_MESH_KEEPALIVE:
1009 case GNUNET_MESSAGE_TYPE_MESH_KX:
1010 case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
1011 case GNUNET_MESSAGE_TYPE_MESH_ACK:
1012 case GNUNET_MESSAGE_TYPE_MESH_POLL:
1013 GNUNET_free_non_null (queue->cls);
1018 LOG (GNUNET_ERROR_TYPE_ERROR, "# type %s unknown!\n",
1019 GM_m2s (queue->type));
1022 GNUNET_CONTAINER_DLL_remove (peer->queue_head, peer->queue_tail, queue);
1024 if (queue->type != GNUNET_MESSAGE_TYPE_MESH_ACK &&
1025 queue->type != GNUNET_MESSAGE_TYPE_MESH_POLL)
1030 if (NULL != queue->callback)
1032 LOG (GNUNET_ERROR_TYPE_DEBUG, "# Calling callback\n");
1033 queue->callback (queue->callback_cls,
1034 queue->c, queue->type,
1035 queue->fwd, queue->size,
1036 GNUNET_TIME_absolute_get_duration (queue->start_waiting));
1039 GNUNET_free (queue);
1044 * @brief Queue and pass message to core when possible.
1046 * @param peer Peer towards which to queue the message.
1047 * @param cls Closure (@c type dependant). It will be used by queue_send to
1048 * build the message to be sent if not already prebuilt.
1049 * @param type Type of the message, 0 for a raw message.
1050 * @param size Size of the message.
1051 * @param c Connection this message belongs to (can be NULL).
1052 * @param fwd Is this a message going root->dest? (FWD ACK are NOT FWD!)
1053 * @param cont Continuation to be called once CORE has taken the message.
1054 * @param cont_cls Closure for @c cont.
1056 * @return Handle to cancel the message before it is sent. Once cont is called
1057 * message has been sent and therefore the handle is no longer valid.
1059 struct MeshPeerQueue *
1060 GMP_queue_add (struct MeshPeer *peer, void *cls, uint16_t type, size_t size,
1061 struct MeshConnection *c, int fwd,
1062 GMP_sent cont, void *cont_cls)
1064 struct MeshPeerQueue *queue;
1068 LOG (GNUNET_ERROR_TYPE_DEBUG,
1069 "queue add %s %s towards %s (size %u) on c %p (%s)\n",
1070 GM_f2s (fwd), GM_m2s (type), GMP_2s(peer),
1071 size, c, GMC_2s (c));
1073 if (NULL == peer->connections)
1075 /* We are not connected to this peer, ignore request. */
1076 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING %s not a neighbor\n", GMP_2s (peer));
1077 GNUNET_STATISTICS_update (stats, "# messages dropped due to wrong hop", 1,
1084 if (GNUNET_MESSAGE_TYPE_MESH_POLL == type ||
1085 GNUNET_MESSAGE_TYPE_MESH_ACK == type)
1090 LOG (GNUNET_ERROR_TYPE_DEBUG, "priority %d\n", priority);
1092 call_core = NULL == c ? GNUNET_YES : GMC_is_sendable (c, fwd);
1093 queue = GNUNET_new (struct MeshPeerQueue);
1100 queue->callback = cont;
1101 queue->callback_cls = cont_cls;
1104 GNUNET_CONTAINER_DLL_insert_tail (peer->queue_head, peer->queue_tail, queue);
1109 GNUNET_CONTAINER_DLL_insert (peer->queue_head, peer->queue_tail, queue);
1110 call_core = GNUNET_YES;
1113 if (NULL == peer->core_transmit && GNUNET_YES == call_core)
1115 LOG (GNUNET_ERROR_TYPE_DEBUG,
1116 "calling core tmt rdy towards %s for %u bytes\n",
1117 GMP_2s (peer), size);
1118 peer->core_transmit =
1119 GNUNET_CORE_notify_transmit_ready (core_handle,
1120 GNUNET_NO, get_priority (queue),
1121 GNUNET_TIME_UNIT_FOREVER_REL,
1122 GNUNET_PEER_resolve2 (peer->id),
1126 queue->start_waiting = GNUNET_TIME_absolute_get ();
1130 LOG (GNUNET_ERROR_TYPE_DEBUG,
1131 "core tmt rdy towards %s already called\n",
1140 * Cancel all queued messages to a peer that belong to a certain connection.
1142 * @param peer Peer towards whom to cancel.
1143 * @param c Connection whose queued messages to cancel. Might be destroyed by
1144 * the sent continuation call.
1147 GMP_queue_cancel (struct MeshPeer *peer, struct MeshConnection *c)
1149 struct MeshPeerQueue *q;
1150 struct MeshPeerQueue *next;
1151 struct MeshPeerQueue *prev;
1153 for (q = peer->queue_head; NULL != q; q = next)
1158 LOG (GNUNET_ERROR_TYPE_DEBUG, "GMP_cancel_queue %s\n", GM_m2s (q->type));
1159 GMP_queue_destroy (q, GNUNET_YES);
1161 /* Get next from prev, q->next might be already freed:
1162 * queue destroy -> callback -> GMC_destroy -> cancel_queues -> here
1165 next = peer->queue_head;
1174 if (NULL == peer->queue_head)
1176 if (NULL != peer->core_transmit)
1178 GNUNET_CORE_notify_transmit_ready_cancel (peer->core_transmit);
1179 peer->core_transmit = NULL;
1186 * Get the first transmittable message for a connection.
1188 * @param peer Neighboring peer.
1189 * @param c Connection.
1191 * @return First transmittable message.
1193 static struct MeshPeerQueue *
1194 connection_get_first_message (struct MeshPeer *peer, struct MeshConnection *c)
1196 struct MeshPeerQueue *q;
1198 for (q = peer->queue_head; NULL != q; q = q->next)
1202 if (queue_is_sendable (q))
1204 LOG (GNUNET_ERROR_TYPE_DEBUG, " sendable!!\n");
1207 LOG (GNUNET_ERROR_TYPE_DEBUG, " not sendable\n");
1215 GMP_queue_unlock (struct MeshPeer *peer, struct MeshConnection *c)
1217 struct MeshPeerQueue *q;
1220 if (NULL != peer->core_transmit)
1222 LOG (GNUNET_ERROR_TYPE_DEBUG, " already unlocked!\n");
1223 return; /* Already unlocked */
1226 q = connection_get_first_message (peer, c);
1229 LOG (GNUNET_ERROR_TYPE_DEBUG, " queue empty!\n");
1230 return; /* Nothing to transmit */
1234 peer->core_transmit =
1235 GNUNET_CORE_notify_transmit_ready (core_handle,
1236 GNUNET_NO, get_priority (q),
1237 GNUNET_TIME_UNIT_FOREVER_REL,
1238 GNUNET_PEER_resolve2 (peer->id),
1246 * Initialize the peer subsystem.
1248 * @param c Configuration.
1251 GMP_init (const struct GNUNET_CONFIGURATION_Handle *c)
1253 LOG (GNUNET_ERROR_TYPE_DEBUG, "init\n");
1254 peers = GNUNET_CONTAINER_multipeermap_create (128, GNUNET_NO);
1256 GNUNET_CONFIGURATION_get_value_number (c, "MESH", "MAX_PEERS",
1259 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_WARNING,
1260 "MESH", "MAX_PEERS", "USING DEFAULT");
1265 GNUNET_CONFIGURATION_get_value_number (c, "MESH", "DROP_PERCENT",
1272 LOG (GNUNET_ERROR_TYPE_WARNING,
1273 "\n***************************************\n"
1274 "Mesh is running with drop mode enabled.\n"
1275 "This is NOT a good idea!\n"
1276 "Remove the DROP_PERCENT option from your configuration.\n"
1277 "***************************************\n");
1280 core_handle = GNUNET_CORE_connect (c, /* Main configuration */
1281 NULL, /* Closure passed to MESH functions */
1282 &core_init, /* Call core_init once connected */
1283 &core_connect, /* Handle connects */
1284 &core_disconnect, /* remove peers on disconnects */
1285 NULL, /* Don't notify about all incoming messages */
1286 GNUNET_NO, /* For header only in notification */
1287 NULL, /* Don't notify about all outbound messages */
1288 GNUNET_NO, /* For header-only out notification */
1289 core_handlers); /* Register these handlers */
1290 if (NULL == core_handle)
1293 GNUNET_SCHEDULER_shutdown ();
1299 * Shut down the peer subsystem.
1304 GNUNET_CONTAINER_multipeermap_iterate (peers, &shutdown_tunnel, NULL);
1306 if (core_handle != NULL)
1308 GNUNET_CORE_disconnect (core_handle);
1311 GNUNET_PEER_change_rc (myid, -1);
1315 * Retrieve the MeshPeer stucture associated with the peer, create one
1316 * and insert it in the appropriate structures if the peer is not known yet.
1318 * @param peer_id Full identity of the peer.
1320 * @return Existing or newly created peer structure.
1323 GMP_get (const struct GNUNET_PeerIdentity *peer_id)
1325 struct MeshPeer *peer;
1327 peer = GNUNET_CONTAINER_multipeermap_get (peers, peer_id);
1330 peer = GNUNET_new (struct MeshPeer);
1331 if (GNUNET_CONTAINER_multipeermap_size (peers) > max_peers)
1333 peer_delete_oldest ();
1335 GNUNET_CONTAINER_multipeermap_put (peers, peer_id, peer,
1336 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1337 peer->id = GNUNET_PEER_intern (peer_id);
1339 peer->last_contact = GNUNET_TIME_absolute_get();
1346 * Retrieve the MeshPeer stucture associated with the peer, create one
1347 * and insert it in the appropriate structures if the peer is not known yet.
1349 * @param peer Short identity of the peer.
1351 * @return Existing or newly created peer structure.
1354 GMP_get_short (const GNUNET_PEER_Id peer)
1356 return GMP_get (GNUNET_PEER_resolve2 (peer));
1361 * Try to establish a new connection to this peer (in its tunnel).
1362 * If the peer doesn't have any path to it yet, try to get one.
1363 * If the peer already has some path, send a CREATE CONNECTION towards it.
1365 * @param peer Peer to connect to.
1368 GMP_connect (struct MeshPeer *peer)
1370 struct MeshTunnel3 *t;
1371 struct MeshPeerPath *p;
1372 struct MeshConnection *c;
1375 LOG (GNUNET_ERROR_TYPE_DEBUG, "peer_connect towards %s\n", GMP_2s (peer));
1378 rerun_search = GNUNET_NO;
1380 if (NULL != peer->path_head)
1382 LOG (GNUNET_ERROR_TYPE_DEBUG, " some path exists\n");
1383 p = peer_get_best_path (peer);
1386 LOG (GNUNET_ERROR_TYPE_DEBUG, " %u hops\n", p->length);
1387 c = GMT_use_path (t, p);
1390 /* This case can happen when the path includes a first hop that is
1391 * not yet known to be connected.
1393 * This happens quite often during testing when running mesh
1394 * under valgrind: core connect notifications come very late and the
1395 * DHT result has already come and created a valid path.
1396 * In this case, the peer->connections hashmap will be NULL and
1397 * tunnel_use_path will not be able to create a connection from that
1400 * Re-running the DHT GET should give core time to callback.
1402 * GMT_use_path -> GMC_new -> register_neighbors takes care of
1403 * updating statistics about this issue.
1405 rerun_search = GNUNET_YES;
1409 GMC_send_create (c);
1415 LOG (GNUNET_ERROR_TYPE_DEBUG, " but is NULL, all paths are in use\n");
1419 if (NULL != peer->search_h && GNUNET_YES == rerun_search)
1421 GMD_search_stop (peer->search_h);
1422 peer->search_h = NULL;
1423 LOG (GNUNET_ERROR_TYPE_DEBUG,
1424 " Stopping DHT GET for peer %s\n",
1428 if (NULL == peer->search_h)
1430 const struct GNUNET_PeerIdentity *id;
1432 id = GNUNET_PEER_resolve2 (peer->id);
1433 LOG (GNUNET_ERROR_TYPE_DEBUG,
1434 " Starting DHT GET for peer %s\n", GMP_2s (peer));
1435 peer->search_h = GMD_search (id, &search_handler, peer);
1436 if (MESH_TUNNEL3_NEW == GMT_get_cstate (t))
1437 GMT_change_cstate (t, MESH_TUNNEL3_SEARCHING);
1449 GMP_set_tunnel (struct MeshPeer *peer, struct MeshTunnel3 *t)
1456 * Chech whether there is a direct (core level) connection to peer.
1458 * @param peer Peer to check.
1460 * @return #GNUNET_YES if there is a direct connection.
1463 GMP_is_neighbor (const struct MeshPeer *peer)
1465 struct MeshPeerPath *path;
1467 if (NULL == peer->connections)
1470 for (path = peer->path_head; NULL != path; path = path->next)
1472 if (3 > path->length)
1476 /* Is not a neighbor but connections is not NULL, probably disconnecting */
1482 * Create and initialize a new tunnel towards a peer, in case it has none.
1483 * In case the peer already has a tunnel, nothing is done.
1485 * Does not generate any traffic, just creates the local data structures.
1487 * @param peer Peer towards which to create the tunnel.
1490 GMP_add_tunnel (struct MeshPeer *peer)
1492 if (NULL != peer->tunnel)
1494 peer->tunnel = GMT_new (peer);
1499 * Add a connection to a neighboring peer.
1501 * Store that the peer is the first hop of the connection in one
1502 * direction and that on peer disconnect the connection must be
1503 * notified and destroyed, for it will no longer be valid.
1505 * @param peer Peer to add connection to.
1506 * @param c Connection to add.
1508 * @return GNUNET_OK on success.
1511 GMP_add_connection (struct MeshPeer *peer,
1512 struct MeshConnection *c)
1515 LOG (GNUNET_ERROR_TYPE_DEBUG, "adding connection %s\n", GMC_2s (c));
1516 LOG (GNUNET_ERROR_TYPE_DEBUG, "to peer %s\n", GMP_2s (peer));
1518 if (NULL == peer->connections)
1521 LOG (GNUNET_ERROR_TYPE_DEBUG,
1522 "Peer %s is not a neighbor!\n",
1524 return GNUNET_SYSERR;
1526 LOG (GNUNET_ERROR_TYPE_DEBUG,
1527 "peer %s ok, has %u connections.\n",
1528 GMP_2s (peer), GNUNET_CONTAINER_multihashmap_size (peer->connections));
1529 result = GNUNET_CONTAINER_multihashmap_put (peer->connections,
1532 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1533 LOG (GNUNET_ERROR_TYPE_DEBUG,
1534 " now has %u connections.\n",
1535 GNUNET_CONTAINER_multihashmap_size (peer->connections));
1536 LOG (GNUNET_ERROR_TYPE_DEBUG, "result %u\n", result);
1543 * Add the path to the peer and update the path used to reach it in case this
1546 * @param peer Destination peer to add the path to.
1547 * @param path New path to add. Last peer must be the peer in arg 1.
1548 * Path will be either used of freed if already known.
1549 * @param trusted Do we trust that this path is real?
1551 * @return path if path was taken, pointer to existing duplicate if exists
1554 struct MeshPeerPath *
1555 GMP_add_path (struct MeshPeer *peer, struct MeshPeerPath *path,
1558 struct MeshPeerPath *aux;
1562 LOG (GNUNET_ERROR_TYPE_DEBUG, "adding path [%u] to peer %s\n",
1563 path->length, GMP_2s (peer));
1565 if ((NULL == peer) || (NULL == path))
1568 path_destroy (path);
1571 if (path->peers[path->length - 1] != peer->id)
1574 path_destroy (path);
1577 if (2 >= path->length && GNUNET_NO == trusted)
1579 /* Only allow CORE to tell us about direct paths */
1580 path_destroy (path);
1583 for (l = 1; l < path->length; l++)
1585 if (path->peers[l] == myid)
1587 LOG (GNUNET_ERROR_TYPE_DEBUG, "shortening path by %u\n", l);
1588 for (l2 = 0; l2 < path->length - l; l2++)
1590 path->peers[l2] = path->peers[l + l2];
1594 path->peers = GNUNET_realloc (path->peers,
1595 path->length * sizeof (GNUNET_PEER_Id));
1599 LOG (GNUNET_ERROR_TYPE_DEBUG, "adding path [%u]\n", path->length);
1601 l = path_get_length (path);
1604 path_destroy (path);
1608 GNUNET_assert (peer->id == path->peers[path->length - 1]);
1609 for (aux = peer->path_head; aux != NULL; aux = aux->next)
1611 l2 = path_get_length (aux);
1614 LOG (GNUNET_ERROR_TYPE_DEBUG, " added\n");
1615 GNUNET_CONTAINER_DLL_insert_before (peer->path_head,
1616 peer->path_tail, aux, path);
1621 if (l2 == l && memcmp (path->peers, aux->peers, l) == 0)
1623 LOG (GNUNET_ERROR_TYPE_DEBUG, " already known\n");
1624 path_destroy (path);
1629 GNUNET_CONTAINER_DLL_insert_tail (peer->path_head, peer->path_tail,
1631 LOG (GNUNET_ERROR_TYPE_DEBUG, " added last\n");
1637 * Add the path to the origin peer and update the path used to reach it in case
1638 * this is the shortest.
1639 * The path is given in peer_info -> destination, therefore we turn the path
1640 * upside down first.
1642 * @param peer Peer to add the path to, being the origin of the path.
1643 * @param path New path to add after being inversed.
1644 * Path will be either used or freed.
1645 * @param trusted Do we trust that this path is real?
1647 * @return path if path was taken, pointer to existing duplicate if exists
1650 struct MeshPeerPath *
1651 GMP_add_path_to_origin (struct MeshPeer *peer,
1652 struct MeshPeerPath *path,
1658 return GMP_add_path (peer, path, trusted);
1663 * Adds a path to the info of all the peers in the path
1665 * @param p Path to process.
1666 * @param confirmed Whether we know if the path works or not.
1669 GMP_add_path_to_all (const struct MeshPeerPath *p, int confirmed)
1673 /* TODO: invert and add */
1674 for (i = 0; i < p->length && p->peers[i] != myid; i++) /* skip'em */ ;
1675 for (i++; i < p->length; i++)
1677 struct MeshPeer *aux;
1678 struct MeshPeerPath *copy;
1680 aux = GMP_get_short (p->peers[i]);
1681 copy = path_duplicate (p);
1682 copy->length = i + 1;
1683 GMP_add_path (aux, copy, p->length < 3 ? GNUNET_NO : confirmed);
1689 * Remove any path to the peer that has the extact same peers as the one given.
1691 * @param peer Peer to remove the path from.
1692 * @param path Path to remove. Is always destroyed .
1695 GMP_remove_path (struct MeshPeer *peer, struct MeshPeerPath *path)
1697 struct MeshPeerPath *iter;
1698 struct MeshPeerPath *next;
1700 GNUNET_assert (myid == path->peers[0]);
1701 GNUNET_assert (peer->id == path->peers[path->length - 1]);
1703 for (iter = peer->path_head; NULL != iter; iter = next)
1706 if (0 == memcmp (path->peers, iter->peers,
1707 sizeof (GNUNET_PEER_Id) * path->length))
1709 GNUNET_CONTAINER_DLL_remove (peer->path_head, peer->path_tail, iter);
1710 path_destroy (iter);
1715 path_destroy (path);
1720 * Remove a connection from a neighboring peer.
1722 * @param peer Peer to remove connection from.
1723 * @param c Connection to remove.
1725 * @return GNUNET_OK on success.
1728 GMP_remove_connection (struct MeshPeer *peer,
1729 const struct MeshConnection *c)
1731 LOG (GNUNET_ERROR_TYPE_DEBUG, "removing connection %s\n", GMC_2s (c));
1732 LOG (GNUNET_ERROR_TYPE_DEBUG, "from peer %s\n", GMP_2s (peer));
1734 if (NULL == peer || NULL == peer->connections)
1736 LOG (GNUNET_ERROR_TYPE_DEBUG,
1737 "Peer %s is not a neighbor!\n",
1739 return GNUNET_SYSERR;
1741 LOG (GNUNET_ERROR_TYPE_DEBUG,
1742 "peer %s ok, has %u connections.\n",
1743 GMP_2s (peer), GNUNET_CONTAINER_multihashmap_size (peer->connections));
1745 return GNUNET_CONTAINER_multihashmap_remove (peer->connections,
1751 * Start the DHT search for new paths towards the peer: we don't have
1752 * enough good connections.
1754 * @param peer Destination peer.
1757 GMP_start_search (struct MeshPeer *peer)
1759 if (NULL != peer->search_h)
1765 peer->search_h = GMD_search (GMP_get_id (peer), &search_handler, peer);
1770 * Stop the DHT search for new paths towards the peer: we already have
1771 * enough good connections.
1773 * @param peer Destination peer.
1776 GMP_stop_search (struct MeshPeer *peer)
1778 if (NULL == peer->search_h)
1784 GMD_search_stop (peer->search_h);
1785 peer->search_h = NULL;
1790 * Get the Full ID of a peer.
1792 * @param peer Peer to get from.
1794 * @return Full ID of peer.
1796 const struct GNUNET_PeerIdentity *
1797 GMP_get_id (const struct MeshPeer *peer)
1799 return GNUNET_PEER_resolve2 (peer->id);
1804 * Get the Short ID of a peer.
1806 * @param peer Peer to get from.
1808 * @return Short ID of peer.
1811 GMP_get_short_id (const struct MeshPeer *peer)
1818 * Get the tunnel towards a peer.
1820 * @param peer Peer to get from.
1822 * @return Tunnel towards peer.
1824 struct MeshTunnel3 *
1825 GMP_get_tunnel (const struct MeshPeer *peer)
1827 return peer->tunnel;
1832 * Count the number of known paths toward the peer.
1834 * @param peer Peer to get path info.
1836 * @return Number of known paths.
1839 GMP_count_paths (const struct MeshPeer *peer)
1841 struct MeshPeerPath *iter;
1844 for (iter = peer->path_head, i = 0; NULL != iter; iter = iter->next)
1852 * Iterate all known peers.
1854 * @param iter Iterator.
1855 * @param cls Closure for @c iter.
1858 GMP_iterate_all (GNUNET_CONTAINER_PeerMapIterator iter, void *cls)
1860 GNUNET_CONTAINER_multipeermap_iterate (peers, iter, cls);
1865 * Get the static string for a peer ID.
1869 * @return Static string for it's ID.
1872 GMP_2s (const struct MeshPeer *peer)
1876 return GNUNET_i2s (GNUNET_PEER_resolve2 (peer->id));