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 GMC_notify_broken (c, peer);
235 * Method called whenever a given peer connects.
238 * @param peer peer identity this notification is about
241 core_connect (void *cls, const struct GNUNET_PeerIdentity *peer)
244 struct MeshPeerPath *path;
246 LOG (GNUNET_ERROR_TYPE_DEBUG, "Peer connected\n");
247 LOG (GNUNET_ERROR_TYPE_DEBUG, " %s\n", GNUNET_i2s (&my_full_id));
251 LOG (GNUNET_ERROR_TYPE_DEBUG, " (self)\n");
256 LOG (GNUNET_ERROR_TYPE_DEBUG, " %s\n", GNUNET_i2s (peer));
258 path->peers[1] = mp->id;
259 GNUNET_PEER_change_rc (mp->id, 1);
260 GNUNET_STATISTICS_update (stats, "# peers", 1, GNUNET_NO);
262 path->peers[0] = myid;
263 GNUNET_PEER_change_rc (myid, 1);
264 GMP_add_path (mp, path, GNUNET_YES);
266 mp->connections = GNUNET_CONTAINER_multihashmap_create (32, GNUNET_YES);
272 * Method called whenever a peer disconnects.
275 * @param peer peer identity this notification is about
278 core_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
282 LOG (GNUNET_ERROR_TYPE_DEBUG, "Peer disconnected\n");
283 p = GNUNET_CONTAINER_multipeermap_get (peers, peer);
290 LOG (GNUNET_ERROR_TYPE_DEBUG, " (self)\n");
292 LOG (GNUNET_ERROR_TYPE_DEBUG, " %s\n", GMP_2s (p));
295 GNUNET_CONTAINER_multihashmap_iterate (p->connections, ¬ify_broken, p);
296 GNUNET_CONTAINER_multihashmap_destroy (p->connections);
297 p->connections = NULL;
298 if (NULL != p->core_transmit)
300 GNUNET_CORE_notify_transmit_ready_cancel (p->core_transmit);
301 p->core_transmit = NULL;
303 GNUNET_STATISTICS_update (stats, "# peers", -1, GNUNET_NO);
310 * Functions to handle messages from core
312 static struct GNUNET_CORE_MessageHandler core_handlers[] = {
313 {&GMC_handle_create, GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE,
315 {&GMC_handle_confirm, GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK,
316 sizeof (struct GNUNET_MESH_ConnectionACK)},
317 {&GMC_handle_broken, GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN,
318 sizeof (struct GNUNET_MESH_ConnectionBroken)},
319 {&GMC_handle_destroy, GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY,
320 sizeof (struct GNUNET_MESH_ConnectionDestroy)},
321 {&GMC_handle_keepalive, GNUNET_MESSAGE_TYPE_MESH_KEEPALIVE,
322 sizeof (struct GNUNET_MESH_ConnectionKeepAlive)},
323 {&GMC_handle_ack, GNUNET_MESSAGE_TYPE_MESH_ACK,
324 sizeof (struct GNUNET_MESH_ACK)},
325 {&GMC_handle_poll, GNUNET_MESSAGE_TYPE_MESH_POLL,
326 sizeof (struct GNUNET_MESH_Poll)},
327 {&GMC_handle_encrypted, GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED, 0},
328 {&GMC_handle_kx, GNUNET_MESSAGE_TYPE_MESH_KX, 0},
334 * To be called on core init/fail.
336 * @param cls Closure (config)
337 * @param identity the public identity of this peer
340 core_init (void *cls,
341 const struct GNUNET_PeerIdentity *identity)
343 const struct GNUNET_CONFIGURATION_Handle *c = cls;
346 LOG (GNUNET_ERROR_TYPE_DEBUG, "Core init\n");
347 if (0 != memcmp (identity, &my_full_id, sizeof (my_full_id)))
349 LOG (GNUNET_ERROR_TYPE_ERROR, _("Wrong CORE service\n"));
350 LOG (GNUNET_ERROR_TYPE_ERROR, " core id %s\n", GNUNET_i2s (identity));
351 LOG (GNUNET_ERROR_TYPE_ERROR, " my id %s\n", GNUNET_i2s (&my_full_id));
352 GNUNET_CORE_disconnect (core_handle);
353 core_handle = GNUNET_CORE_connect (c, /* Main configuration */
354 NULL, /* Closure passed to MESH functions */
355 &core_init, /* Call core_init once connected */
356 &core_connect, /* Handle connects */
357 &core_disconnect, /* remove peers on disconnects */
358 NULL, /* Don't notify about all incoming messages */
359 GNUNET_NO, /* For header only in notification */
360 NULL, /* Don't notify about all outbound messages */
361 GNUNET_NO, /* For header-only out notification */
362 core_handlers); /* Register these handlers */
371 * Core callback to write a pre-constructed data packet to core buffer
373 * @param cls Closure (MeshTransmissionDescriptor with data in "data" member).
374 * @param size Number of bytes available in buf.
375 * @param buf Where the to write the message.
377 * @return number of bytes written to buf
380 send_core_data_raw (void *cls, size_t size, void *buf)
382 struct GNUNET_MessageHeader *msg = cls;
385 GNUNET_assert (NULL != msg);
386 total_size = ntohs (msg->size);
388 if (total_size > size)
393 memcpy (buf, msg, total_size);
400 * Function to send a create connection message to a peer.
402 * @param c Connection to create.
403 * @param size number of bytes available in buf
404 * @param buf where the callee should write the message
405 * @return number of bytes written to buf
408 send_core_connection_create (struct MeshConnection *c, size_t size, void *buf)
410 struct GNUNET_MESH_ConnectionCreate *msg;
411 struct GNUNET_PeerIdentity *peer_ptr;
412 const struct MeshPeerPath *p = GMC_get_path (c);
416 LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending CONNECTION CREATE...\n");
418 sizeof (struct GNUNET_MESH_ConnectionCreate) +
419 p->length * sizeof (struct GNUNET_PeerIdentity);
421 if (size < size_needed || NULL == buf)
426 msg = (struct GNUNET_MESH_ConnectionCreate *) buf;
427 msg->header.size = htons (size_needed);
428 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE);
429 msg->cid = *GMC_get_id (c);
431 peer_ptr = (struct GNUNET_PeerIdentity *) &msg[1];
432 for (i = 0; i < p->length; i++)
434 GNUNET_PEER_resolve (p->peers[i], peer_ptr++);
437 LOG (GNUNET_ERROR_TYPE_DEBUG,
438 "CONNECTION CREATE (%u bytes long) sent!\n",
445 * Creates a path ack message in buf and frees all unused resources.
447 * @param c Connection to send an ACK on.
448 * @param size number of bytes available in buf
449 * @param buf where the callee should write the message
451 * @return number of bytes written to buf
454 send_core_connection_ack (struct MeshConnection *c, size_t size, void *buf)
456 struct GNUNET_MESH_ConnectionACK *msg = buf;
458 LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending CONNECTION ACK...\n");
459 if (sizeof (struct GNUNET_MESH_ConnectionACK) > size)
464 msg->header.size = htons (sizeof (struct GNUNET_MESH_ConnectionACK));
465 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK);
466 msg->cid = *GMC_get_id (c);
469 /* TODO add signature */
471 LOG (GNUNET_ERROR_TYPE_DEBUG, "CONNECTION ACK sent!\n");
472 return sizeof (struct GNUNET_MESH_ConnectionACK);
476 /******************************************************************************/
477 /******************************** STATIC ***********************************/
478 /******************************************************************************/
481 * Iterator over tunnel hash map entries to destroy the tunnel during shutdown.
484 * @param key current key code
485 * @param value value in the hash map
486 * @return #GNUNET_YES if we should continue to iterate,
490 shutdown_tunnel (void *cls,
491 const struct GNUNET_PeerIdentity *key,
494 struct MeshPeer *p = value;
495 struct MeshTunnel3 *t = p->tunnel;
505 * Destroy the peer_info and free any allocated resources linked to it
507 * @param peer The peer_info to destroy.
509 * @return GNUNET_OK on success
512 peer_destroy (struct MeshPeer *peer)
514 struct GNUNET_PeerIdentity id;
515 struct MeshPeerPath *p;
516 struct MeshPeerPath *nextp;
518 GNUNET_PEER_resolve (peer->id, &id);
519 GNUNET_PEER_change_rc (peer->id, -1);
521 LOG (GNUNET_ERROR_TYPE_WARNING, "destroying peer %s\n", GNUNET_i2s (&id));
524 GNUNET_CONTAINER_multipeermap_remove (peers, &id, peer))
527 LOG (GNUNET_ERROR_TYPE_WARNING, " not in peermap!!\n");
529 if (NULL != peer->search_h)
531 GMD_search_stop (peer->search_h);
537 GNUNET_CONTAINER_DLL_remove (peer->path_head, peer->path_tail, p);
541 GMT_destroy_empty (peer->tunnel);
548 * Returns if peer is used (has a tunnel or is neighbor).
550 * @param peer Peer to check.
552 * @return #GNUNET_YES if peer is in use.
555 peer_is_used (struct MeshPeer *peer)
557 struct MeshPeerPath *p;
559 if (NULL != peer->tunnel)
562 for (p = peer->path_head; NULL != p; p = p->next)
572 * Iterator over all the peers to get the oldest timestamp.
574 * @param cls Closure (unsued).
575 * @param key ID of the peer.
576 * @param value Peer_Info of the peer.
579 peer_get_oldest (void *cls,
580 const struct GNUNET_PeerIdentity *key,
583 struct MeshPeer *p = value;
584 struct GNUNET_TIME_Absolute *abs = cls;
586 /* Don't count active peers */
587 if (GNUNET_YES == peer_is_used (p))
590 if (abs->abs_value_us < p->last_contact.abs_value_us)
591 abs->abs_value_us = p->last_contact.abs_value_us;
598 * Iterator over all the peers to remove the oldest entry.
600 * @param cls Closure (unsued).
601 * @param key ID of the peer.
602 * @param value Peer_Info of the peer.
605 peer_timeout (void *cls,
606 const struct GNUNET_PeerIdentity *key,
609 struct MeshPeer *p = value;
610 struct GNUNET_TIME_Absolute *abs = cls;
612 LOG (GNUNET_ERROR_TYPE_WARNING,
613 "peer %s timeout\n", GNUNET_i2s (key));
615 if (p->last_contact.abs_value_us == abs->abs_value_us &&
616 GNUNET_NO == peer_is_used (p))
626 * Delete oldest unused peer.
629 peer_delete_oldest (void)
631 struct GNUNET_TIME_Absolute abs;
633 abs = GNUNET_TIME_UNIT_FOREVER_ABS;
635 GNUNET_CONTAINER_multipeermap_iterate (peers,
638 GNUNET_CONTAINER_multipeermap_iterate (peers,
645 * Choose the best path towards a peer considering the tunnel properties.
647 * @param peer The destination peer.
649 * @return Best current known path towards the peer, if any.
651 static struct MeshPeerPath *
652 peer_get_best_path (const struct MeshPeer *peer)
654 struct MeshPeerPath *best_p;
655 struct MeshPeerPath *p;
656 unsigned int best_cost;
659 best_cost = UINT_MAX;
661 for (p = peer->path_head; NULL != p; p = p->next)
663 if (GNUNET_YES == GMT_is_path_used (peer->tunnel, p))
664 continue; /* If path is already in use, skip it. */
666 if ((cost = GMT_get_path_cost (peer->tunnel, p)) < best_cost)
677 queue_is_sendable (struct MeshPeerQueue *q)
679 /* Is PID-independent? */
682 case GNUNET_MESSAGE_TYPE_MESH_ACK:
683 case GNUNET_MESSAGE_TYPE_MESH_POLL:
687 if (GMC_is_sendable (q->c, q->fwd))
695 * Get first sendable message.
697 * @param peer The destination peer.
699 * @return Best current known path towards the peer, if any.
701 static struct MeshPeerQueue *
702 peer_get_first_message (const struct MeshPeer *peer)
704 struct MeshPeerQueue *q;
706 for (q = peer->queue_head; NULL != q; q = q->next)
708 if (queue_is_sendable (q))
717 * Function to process paths received for a new peer addition. The recorded
718 * paths form the initial tunnel, which can be optimized later.
719 * Called on each result obtained for the DHT search.
725 search_handler (void *cls, const struct MeshPeerPath *path)
727 struct MeshPeer *peer = cls;
728 unsigned int connection_count;
730 GMP_add_path_to_all (path, GNUNET_NO);
732 /* Count connections */
733 connection_count = GMT_count_connections (peer->tunnel);
735 /* If we already have 3 (or more (?!)) connections, it's enough */
736 if (3 <= connection_count)
739 if (MESH_TUNNEL3_SEARCHING == GMT_get_cstate (peer->tunnel))
741 LOG (GNUNET_ERROR_TYPE_DEBUG, " ... connect!\n");
749 * Core callback to write a queued packet to core buffer
751 * @param cls Closure (peer info).
752 * @param size Number of bytes available in buf.
753 * @param buf Where the to write the message.
755 * @return number of bytes written to buf
757 * FIXME add GNUNET_MESSAGE_TYPE_MESH_KEEPALIVE
760 queue_send (void *cls, size_t size, void *buf)
762 struct MeshPeer *peer = cls;
763 struct MeshConnection *c;
764 struct MeshPeerQueue *queue;
765 const struct GNUNET_PeerIdentity *dst_id;
768 peer->core_transmit = NULL;
769 LOG (GNUNET_ERROR_TYPE_DEBUG, "* Queue send (max %u)\n", size);
771 if (NULL == buf || 0 == size)
773 LOG (GNUNET_ERROR_TYPE_DEBUG, "* Buffer size 0.\n");
778 queue = peer_get_first_message (peer);
781 GNUNET_break (0); /* Core tmt_rdy should've been canceled */
786 dst_id = GNUNET_PEER_resolve2 (peer->id);
787 LOG (GNUNET_ERROR_TYPE_DEBUG, "* towards %s\n", GNUNET_i2s (dst_id));
788 LOG (GNUNET_ERROR_TYPE_DEBUG, "* on connection %s\n", GMC_2s (c));
789 /* Check if buffer size is enough for the message */
790 if (queue->size > size)
792 LOG (GNUNET_ERROR_TYPE_DEBUG, "* not enough room, reissue\n");
793 peer->core_transmit =
794 GNUNET_CORE_notify_transmit_ready (core_handle,
797 GNUNET_TIME_UNIT_FOREVER_REL,
804 LOG (GNUNET_ERROR_TYPE_DEBUG, "* size %u ok\n", queue->size);
809 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY:
810 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN:
811 case GNUNET_MESSAGE_TYPE_MESH_KEEPALIVE:
812 case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
813 case GNUNET_MESSAGE_TYPE_MESH_KX:
814 case GNUNET_MESSAGE_TYPE_MESH_ACK:
815 case GNUNET_MESSAGE_TYPE_MESH_POLL:
816 LOG (GNUNET_ERROR_TYPE_DEBUG,
818 GM_m2s (queue->type));
819 data_size = send_core_data_raw (queue->cls, size, buf);
821 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE:
822 LOG (GNUNET_ERROR_TYPE_DEBUG, "* path create\n");
823 if (GMC_is_origin (c, GNUNET_YES))
824 data_size = send_core_connection_create (queue->c, size, buf);
826 data_size = send_core_data_raw (queue->cls, size, buf);
828 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK:
829 LOG (GNUNET_ERROR_TYPE_DEBUG, "* path ack\n");
830 if (GMC_is_origin (c, GNUNET_NO) ||
831 GMC_is_origin (c, GNUNET_YES))
832 data_size = send_core_connection_ack (queue->c, size, buf);
834 data_size = send_core_data_raw (queue->cls, size, buf);
836 case GNUNET_MESSAGE_TYPE_MESH_DATA:
837 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE:
838 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY:
839 /* This should be encapsulted */
845 LOG (GNUNET_ERROR_TYPE_WARNING, "* type unknown: %u\n", queue->type);
849 if (0 < drop_percent &&
850 GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 101) < drop_percent)
852 LOG (GNUNET_ERROR_TYPE_WARNING,
853 "Dropping message of type %s\n",
854 GM_m2s (queue->type));
858 /* Free queue, but cls was freed by send_core_* */
859 GMP_queue_destroy (queue, GNUNET_NO);
861 /* If more data in queue, send next */
862 queue = peer_get_first_message (peer);
865 LOG (GNUNET_ERROR_TYPE_DEBUG, "* more data!\n");
866 if (NULL == peer->core_transmit)
868 peer->core_transmit =
869 GNUNET_CORE_notify_transmit_ready(core_handle,
872 GNUNET_TIME_UNIT_FOREVER_REL,
877 queue->start_waiting = GNUNET_TIME_absolute_get ();
881 LOG (GNUNET_ERROR_TYPE_DEBUG,
882 "* tmt rdy called somewhere else\n");
884 // GMC_start_poll (); FIXME needed?
888 // GMC_stop_poll(); FIXME needed?
891 LOG (GNUNET_ERROR_TYPE_DEBUG, "* Return %d\n", data_size);
896 /******************************************************************************/
897 /******************************** API ***********************************/
898 /******************************************************************************/
902 * Free a transmission that was already queued with all resources
903 * associated to the request.
905 * @param queue Queue handler to cancel.
906 * @param clear_cls Is it necessary to free associated cls?
909 GMP_queue_destroy (struct MeshPeerQueue *queue, int clear_cls)
911 struct MeshPeer *peer;
914 GNUNET_assert (NULL != queue->c);
916 if (GNUNET_YES == clear_cls)
918 LOG (GNUNET_ERROR_TYPE_DEBUG, "# queue destroy type %s\n",
919 GM_m2s (queue->type));
922 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY:
923 LOG (GNUNET_ERROR_TYPE_INFO, "destroying a DESTROY message\n");
925 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK:
926 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE:
927 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN:
928 case GNUNET_MESSAGE_TYPE_MESH_KX:
929 case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
930 case GNUNET_MESSAGE_TYPE_MESH_ACK:
931 case GNUNET_MESSAGE_TYPE_MESH_POLL:
932 GNUNET_free_non_null (queue->cls);
937 LOG (GNUNET_ERROR_TYPE_ERROR, "# type %s unknown!\n",
938 GM_m2s (queue->type));
941 GNUNET_CONTAINER_DLL_remove (peer->queue_head, peer->queue_tail, queue);
943 if (queue->type != GNUNET_MESSAGE_TYPE_MESH_ACK &&
944 queue->type != GNUNET_MESSAGE_TYPE_MESH_POLL)
949 if (NULL != queue->callback)
951 LOG (GNUNET_ERROR_TYPE_DEBUG, "# Calling callback\n");
952 queue->callback (queue->callback_cls,
953 queue->c, queue->type,
954 queue->fwd, queue->size,
955 GNUNET_TIME_absolute_get_duration (queue->start_waiting));
963 * @brief Queue and pass message to core when possible.
965 * @param peer Peer towards which to queue the message.
966 * @param cls Closure (@c type dependant). It will be used by queue_send to
967 * build the message to be sent if not already prebuilt.
968 * @param type Type of the message, 0 for a raw message.
969 * @param size Size of the message.
970 * @param c Connection this message belongs to (cannot be NULL).
971 * @param fwd Is this a message going root->dest? (FWD ACK are NOT FWD!)
972 * @param cont Continuation to be called once CORE has taken the message.
973 * @param cont_cls Closure for @c cont.
975 * @return Handle to cancel the message before it is sent. Once cont is called
976 * message has been sent and therefore the handle is no longer valid.
978 struct MeshPeerQueue *
979 GMP_queue_add (struct MeshPeer *peer, void *cls, uint16_t type, size_t size,
980 struct MeshConnection *c, int fwd,
981 GMP_sent cont, void *cont_cls)
983 struct MeshPeerQueue *queue;
987 LOG (GNUNET_ERROR_TYPE_DEBUG,
988 "queue add %s %s towards %s (size %u) on c %p (%s)\n",
989 GM_f2s (fwd), GM_m2s (type), GMP_2s(peer),
990 size, c, GMC_2s (c));
991 GNUNET_assert (NULL != c);
993 if (NULL == peer->connections)
995 /* We are not connected to this peer, ignore request. */
1002 if (GNUNET_MESSAGE_TYPE_MESH_POLL == type ||
1003 GNUNET_MESSAGE_TYPE_MESH_ACK == type)
1008 LOG (GNUNET_ERROR_TYPE_DEBUG, "priority %d\n", priority);
1010 call_core = GMC_is_sendable (c, fwd);
1011 queue = GNUNET_malloc (sizeof (struct MeshPeerQueue));
1018 queue->callback = cont;
1019 queue->callback_cls = cont_cls;
1022 GNUNET_CONTAINER_DLL_insert_tail (peer->queue_head, peer->queue_tail, queue);
1027 GNUNET_CONTAINER_DLL_insert (peer->queue_head, peer->queue_tail, queue);
1028 call_core = GNUNET_YES;
1031 if (NULL == peer->core_transmit && GNUNET_YES == call_core)
1033 LOG (GNUNET_ERROR_TYPE_DEBUG,
1034 "calling core tmt rdy towards %s for %u bytes\n",
1035 GMP_2s (peer), size);
1036 peer->core_transmit =
1037 GNUNET_CORE_notify_transmit_ready (core_handle,
1040 GNUNET_TIME_UNIT_FOREVER_REL,
1041 GNUNET_PEER_resolve2 (peer->id),
1045 queue->start_waiting = GNUNET_TIME_absolute_get ();
1049 LOG (GNUNET_ERROR_TYPE_DEBUG,
1050 "core tmt rdy towards %s already called\n",
1059 * Cancel all queued messages to a peer that belong to a certain connection.
1061 * @param peer Peer towards whom to cancel.
1062 * @param c Connection whose queued messages to cancel. Might be destroyed by
1063 * the sent continuation call.
1066 GMP_queue_cancel (struct MeshPeer *peer, struct MeshConnection *c)
1068 struct MeshPeerQueue *q;
1069 struct MeshPeerQueue *next;
1070 struct MeshPeerQueue *prev;
1072 for (q = peer->queue_head; NULL != q; q = next)
1077 LOG (GNUNET_ERROR_TYPE_DEBUG,
1078 "GMP_cancel_queue %s\n",
1080 GMP_queue_destroy (q, GNUNET_YES);
1082 /* Get next from prev, q->next might be already freed:
1083 * queue destroy -> callback -> GMC_destroy -> cancel_queues -> here
1086 next = peer->queue_head;
1095 if (NULL == peer->queue_head)
1097 if (NULL != peer->core_transmit)
1099 GNUNET_CORE_notify_transmit_ready_cancel (peer->core_transmit);
1100 peer->core_transmit = NULL;
1107 * Get the first transmittable message for a connection.
1109 * @param peer Neighboring peer.
1110 * @param c Connection.
1112 * @return First transmittable message.
1114 static struct MeshPeerQueue *
1115 connection_get_first_message (struct MeshPeer *peer, struct MeshConnection *c)
1117 struct MeshPeerQueue *q;
1119 for (q = peer->queue_head; NULL != q; q = q->next)
1123 if (queue_is_sendable (q))
1125 LOG (GNUNET_ERROR_TYPE_DEBUG, " sendable!!\n");
1128 LOG (GNUNET_ERROR_TYPE_DEBUG, " not sendable\n");
1136 GMP_queue_unlock (struct MeshPeer *peer, struct MeshConnection *c)
1138 struct MeshPeerQueue *q;
1141 if (NULL != peer->core_transmit)
1143 LOG (GNUNET_ERROR_TYPE_DEBUG, " already unlocked!\n");
1144 return; /* Already unlocked */
1147 q = connection_get_first_message (peer, c);
1150 LOG (GNUNET_ERROR_TYPE_DEBUG, " queue empty!\n");
1151 return; /* Nothing to transmit */
1155 peer->core_transmit =
1156 GNUNET_CORE_notify_transmit_ready (core_handle,
1159 GNUNET_TIME_UNIT_FOREVER_REL,
1160 GNUNET_PEER_resolve2 (peer->id),
1168 * Initialize the peer subsystem.
1170 * @param c Configuration.
1173 GMP_init (const struct GNUNET_CONFIGURATION_Handle *c)
1175 LOG (GNUNET_ERROR_TYPE_DEBUG, "init\n");
1176 peers = GNUNET_CONTAINER_multipeermap_create (128, GNUNET_NO);
1178 GNUNET_CONFIGURATION_get_value_number (c, "MESH", "MAX_PEERS",
1181 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_WARNING,
1182 "MESH", "MAX_PEERS", "USING DEFAULT");
1187 GNUNET_CONFIGURATION_get_value_number (c, "MESH", "DROP_PERCENT",
1194 LOG (GNUNET_ERROR_TYPE_WARNING,
1195 "\n***************************************\n"
1196 "Mesh is running with drop mode enabled.\n"
1197 "This is NOT a good idea!\n"
1198 "Remove the DROP_PERCENT option from your configuration.\n"
1199 "***************************************\n");
1202 core_handle = GNUNET_CORE_connect (c, /* Main configuration */
1203 NULL, /* Closure passed to MESH functions */
1204 &core_init, /* Call core_init once connected */
1205 &core_connect, /* Handle connects */
1206 &core_disconnect, /* remove peers on disconnects */
1207 NULL, /* Don't notify about all incoming messages */
1208 GNUNET_NO, /* For header only in notification */
1209 NULL, /* Don't notify about all outbound messages */
1210 GNUNET_NO, /* For header-only out notification */
1211 core_handlers); /* Register these handlers */
1212 if (NULL == core_handle)
1215 GNUNET_SCHEDULER_shutdown ();
1221 * Shut down the peer subsystem.
1226 GNUNET_CONTAINER_multipeermap_iterate (peers, &shutdown_tunnel, NULL);
1228 if (core_handle != NULL)
1230 GNUNET_CORE_disconnect (core_handle);
1233 GNUNET_PEER_change_rc (myid, -1);
1237 * Retrieve the MeshPeer stucture associated with the peer, create one
1238 * and insert it in the appropriate structures if the peer is not known yet.
1240 * @param peer_id Full identity of the peer.
1242 * @return Existing or newly created peer structure.
1245 GMP_get (const struct GNUNET_PeerIdentity *peer_id)
1247 struct MeshPeer *peer;
1249 peer = GNUNET_CONTAINER_multipeermap_get (peers, peer_id);
1252 peer = GNUNET_new (struct MeshPeer);
1253 if (GNUNET_CONTAINER_multipeermap_size (peers) > max_peers)
1255 peer_delete_oldest ();
1257 GNUNET_CONTAINER_multipeermap_put (peers, peer_id, peer,
1258 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1259 peer->id = GNUNET_PEER_intern (peer_id);
1261 peer->last_contact = GNUNET_TIME_absolute_get();
1268 * Retrieve the MeshPeer stucture associated with the peer, create one
1269 * and insert it in the appropriate structures if the peer is not known yet.
1271 * @param peer Short identity of the peer.
1273 * @return Existing or newly created peer structure.
1276 GMP_get_short (const GNUNET_PEER_Id peer)
1278 return GMP_get (GNUNET_PEER_resolve2 (peer));
1283 * Try to establish a new connection to this peer (in its tunnel).
1284 * If the peer doesn't have any path to it yet, try to get one.
1285 * If the peer already has some path, send a CREATE CONNECTION towards it.
1287 * @param peer Peer to connect to.
1290 GMP_connect (struct MeshPeer *peer)
1292 struct MeshTunnel3 *t;
1293 struct MeshPeerPath *p;
1294 struct MeshConnection *c;
1297 LOG (GNUNET_ERROR_TYPE_DEBUG,
1298 "peer_connect towards %s\n",
1302 rerun_search = GNUNET_NO;
1304 if (NULL != peer->path_head)
1306 LOG (GNUNET_ERROR_TYPE_DEBUG, "path exists\n");
1307 p = peer_get_best_path (peer);
1310 LOG (GNUNET_ERROR_TYPE_DEBUG, " %u hops\n", p->length);
1311 c = GMT_use_path (t, p);
1314 /* This case can happen when the path includes a first hop that is
1315 * not yet known to be connected.
1317 * This happens quite often during testing when running mesh
1318 * under valgrind: core connect notifications come very late and the
1319 * DHT result has already come and created a valid path.
1320 * In this case, the peer->connections hashmap will be NULL and
1321 * tunnel_use_path will not be able to create a connection from that
1324 * Re-running the DHT GET should give core time to callback.
1327 rerun_search = GNUNET_YES;
1331 GMC_send_create (c);
1337 LOG (GNUNET_ERROR_TYPE_DEBUG, "but is NULL!!\n");
1342 if (NULL != peer->search_h && GNUNET_YES == rerun_search)
1344 GMD_search_stop (peer->search_h);
1345 peer->search_h = NULL;
1346 LOG (GNUNET_ERROR_TYPE_DEBUG,
1347 " Stopping DHT GET for peer %s\n",
1351 if (NULL == peer->search_h)
1353 const struct GNUNET_PeerIdentity *id;
1355 id = GNUNET_PEER_resolve2 (peer->id);
1356 LOG (GNUNET_ERROR_TYPE_DEBUG,
1357 " Starting DHT GET for peer %s\n", GMP_2s (peer));
1358 peer->search_h = GMD_search (id, &search_handler, peer);
1359 if (MESH_TUNNEL3_NEW == GMT_get_cstate (t))
1360 GMT_change_cstate (t, MESH_TUNNEL3_SEARCHING);
1372 GMP_set_tunnel (struct MeshPeer *peer, struct MeshTunnel3 *t)
1379 * Chech whether there is a direct (core level) connection to peer.
1381 * @param peer Peer to check.
1383 * @return #GNUNET_YES if there is a direct connection.
1386 GMP_is_neighbor (const struct MeshPeer *peer)
1388 struct MeshPeerPath *path;
1390 if (NULL == peer->connections)
1393 for (path = peer->path_head; NULL != path; path = path->next)
1395 if (3 > path->length)
1399 GNUNET_break (0); /* Is not a neighbor but connections is not NULL */
1405 * Create and initialize a new tunnel towards a peer, in case it has none.
1406 * In case the peer already has a tunnel, nothing is done.
1408 * Does not generate any traffic, just creates the local data structures.
1410 * @param peer Peer towards which to create the tunnel.
1413 GMP_add_tunnel (struct MeshPeer *peer)
1415 if (NULL != peer->tunnel)
1417 peer->tunnel = GMT_new (peer);
1422 * Add a connection to a neighboring peer.
1424 * Store that the peer is the first hop of the connection in one
1425 * direction and that on peer disconnect the connection must be
1426 * notified and destroyed, for it will no longer be valid.
1428 * @param peer Peer to add connection to.
1429 * @param c Connection to add.
1431 * @return GNUNET_OK on success.
1434 GMP_add_connection (struct MeshPeer *peer,
1435 struct MeshConnection *c)
1437 if (NULL == peer->connections)
1440 return GNUNET_SYSERR;
1442 return GNUNET_CONTAINER_multihashmap_put (peer->connections,
1445 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1450 * Add the path to the peer and update the path used to reach it in case this
1453 * @param peer Destination peer to add the path to.
1454 * @param path New path to add. Last peer must be the peer in arg 1.
1455 * Path will be either used of freed if already known.
1456 * @param trusted Do we trust that this path is real?
1458 * @return path if path was taken, pointer to existing duplicate if exists
1461 struct MeshPeerPath *
1462 GMP_add_path (struct MeshPeer *peer, struct MeshPeerPath *path,
1465 struct MeshPeerPath *aux;
1469 LOG (GNUNET_ERROR_TYPE_DEBUG, "adding path [%u] to peer %s\n",
1470 path->length, GMP_2s (peer));
1472 if ((NULL == peer) || (NULL == path))
1475 path_destroy (path);
1478 if (path->peers[path->length - 1] != peer->id)
1481 path_destroy (path);
1484 if (2 >= path->length && GNUNET_NO == trusted)
1486 /* Only allow CORE to tell us about direct paths */
1487 path_destroy (path);
1490 for (l = 1; l < path->length; l++)
1492 if (path->peers[l] == myid)
1494 LOG (GNUNET_ERROR_TYPE_DEBUG, "shortening path by %u\n", l);
1495 for (l2 = 0; l2 < path->length - l; l2++)
1497 path->peers[l2] = path->peers[l + l2];
1501 path->peers = GNUNET_realloc (path->peers,
1502 path->length * sizeof (GNUNET_PEER_Id));
1506 LOG (GNUNET_ERROR_TYPE_DEBUG, "adding path [%u]\n", path->length);
1508 l = path_get_length (path);
1511 path_destroy (path);
1515 GNUNET_assert (peer->id == path->peers[path->length - 1]);
1516 for (aux = peer->path_head; aux != NULL; aux = aux->next)
1518 l2 = path_get_length (aux);
1521 LOG (GNUNET_ERROR_TYPE_DEBUG, " added\n");
1522 GNUNET_CONTAINER_DLL_insert_before (peer->path_head,
1523 peer->path_tail, aux, path);
1528 if (l2 == l && memcmp (path->peers, aux->peers, l) == 0)
1530 LOG (GNUNET_ERROR_TYPE_DEBUG, " already known\n");
1531 path_destroy (path);
1536 GNUNET_CONTAINER_DLL_insert_tail (peer->path_head, peer->path_tail,
1538 LOG (GNUNET_ERROR_TYPE_DEBUG, " added last\n");
1544 * Add the path to the origin peer and update the path used to reach it in case
1545 * this is the shortest.
1546 * The path is given in peer_info -> destination, therefore we turn the path
1547 * upside down first.
1549 * @param peer Peer to add the path to, being the origin of the path.
1550 * @param path New path to add after being inversed.
1551 * Path will be either used or freed.
1552 * @param trusted Do we trust that this path is real?
1554 * @return path if path was taken, pointer to existing duplicate if exists
1557 struct MeshPeerPath *
1558 GMP_add_path_to_origin (struct MeshPeer *peer,
1559 struct MeshPeerPath *path,
1565 return GMP_add_path (peer, path, trusted);
1570 * Adds a path to the info of all the peers in the path
1572 * @param p Path to process.
1573 * @param confirmed Whether we know if the path works or not.
1576 GMP_add_path_to_all (const struct MeshPeerPath *p, int confirmed)
1580 /* TODO: invert and add */
1581 for (i = 0; i < p->length && p->peers[i] != myid; i++) /* skip'em */ ;
1582 for (i++; i < p->length; i++)
1584 struct MeshPeer *aux;
1585 struct MeshPeerPath *copy;
1587 aux = GMP_get_short (p->peers[i]);
1588 copy = path_duplicate (p);
1589 copy->length = i + 1;
1590 GMP_add_path (aux, copy, p->length < 3 ? GNUNET_NO : confirmed);
1596 * Remove a connection from a neighboring peer.
1598 * @param peer Peer to remove connection from.
1599 * @param c Connection to remove.
1601 * @return GNUNET_OK on success.
1604 GMP_remove_connection (struct MeshPeer *peer,
1605 const struct MeshConnection *c)
1607 if (NULL == peer || NULL == peer->connections)
1610 LOG (GNUNET_ERROR_TYPE_WARNING,
1611 "Peer %s is not a neighbor!\n",
1613 return GNUNET_SYSERR;
1615 return GNUNET_CONTAINER_multihashmap_remove (peer->connections,
1621 * Start the DHT search for new paths towards the peer: we don't have
1622 * enough good connections.
1624 * @param peer Destination peer.
1627 GMP_start_search (struct MeshPeer *peer)
1629 if (NULL != peer->search_h)
1635 peer->search_h = GMD_search (GMP_get_id (peer), &search_handler, peer);
1640 * Stop the DHT search for new paths towards the peer: we already have
1641 * enough good connections.
1643 * @param peer Destination peer.
1646 GMP_stop_search (struct MeshPeer *peer)
1648 if (NULL == peer->search_h)
1654 GMD_search_stop (peer->search_h);
1655 peer->search_h = NULL;
1660 * Get the Full ID of a peer.
1662 * @param peer Peer to get from.
1664 * @return Full ID of peer.
1666 const struct GNUNET_PeerIdentity *
1667 GMP_get_id (const struct MeshPeer *peer)
1669 return GNUNET_PEER_resolve2 (peer->id);
1674 * Get the Short ID of a peer.
1676 * @param peer Peer to get from.
1678 * @return Short ID of peer.
1681 GMP_get_short_id (const struct MeshPeer *peer)
1688 * Get the tunnel towards a peer.
1690 * @param peer Peer to get from.
1692 * @return Tunnel towards peer.
1694 struct MeshTunnel3 *
1695 GMP_get_tunnel (const struct MeshPeer *peer)
1697 return peer->tunnel;
1702 * Get the static string for a peer ID.
1706 * @return Static string for it's ID.
1709 GMP_2s (const struct MeshPeer *peer)
1713 return GNUNET_i2s (GNUNET_PEER_resolve2 (peer->id));