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);
419 LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending CONNECTION CREATE...\n");
421 sizeof (struct GNUNET_MESH_ConnectionCreate) +
422 p->length * sizeof (struct GNUNET_PeerIdentity);
424 if (size < size_needed || NULL == buf)
429 msg = (struct GNUNET_MESH_ConnectionCreate *) buf;
430 msg->header.size = htons (size_needed);
431 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE);
432 msg->cid = *GMC_get_id (c);
434 peer_ptr = (struct GNUNET_PeerIdentity *) &msg[1];
435 for (i = 0; i < p->length; i++)
437 GNUNET_PEER_resolve (p->peers[i], peer_ptr++);
440 LOG (GNUNET_ERROR_TYPE_DEBUG,
441 "CONNECTION CREATE (%u bytes long) sent!\n",
448 * Creates a path ack message in buf and frees all unused resources.
450 * @param c Connection to send an ACK on.
451 * @param size number of bytes available in buf
452 * @param buf where the callee should write the message
454 * @return number of bytes written to buf
457 send_core_connection_ack (struct MeshConnection *c, size_t size, void *buf)
459 struct GNUNET_MESH_ConnectionACK *msg = buf;
461 LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending CONNECTION ACK...\n");
462 if (sizeof (struct GNUNET_MESH_ConnectionACK) > size)
467 msg->header.size = htons (sizeof (struct GNUNET_MESH_ConnectionACK));
468 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK);
469 msg->cid = *GMC_get_id (c);
472 /* TODO add signature */
474 LOG (GNUNET_ERROR_TYPE_DEBUG, "CONNECTION ACK sent!\n");
475 return sizeof (struct GNUNET_MESH_ConnectionACK);
479 /******************************************************************************/
480 /******************************** STATIC ***********************************/
481 /******************************************************************************/
484 * Iterator over tunnel hash map entries to destroy the tunnel during shutdown.
487 * @param key current key code
488 * @param value value in the hash map
489 * @return #GNUNET_YES if we should continue to iterate,
493 shutdown_tunnel (void *cls,
494 const struct GNUNET_PeerIdentity *key,
497 struct MeshPeer *p = value;
498 struct MeshTunnel3 *t = p->tunnel;
508 * Destroy the peer_info and free any allocated resources linked to it
510 * @param peer The peer_info to destroy.
512 * @return GNUNET_OK on success
515 peer_destroy (struct MeshPeer *peer)
517 struct GNUNET_PeerIdentity id;
518 struct MeshPeerPath *p;
519 struct MeshPeerPath *nextp;
521 GNUNET_PEER_resolve (peer->id, &id);
522 GNUNET_PEER_change_rc (peer->id, -1);
524 LOG (GNUNET_ERROR_TYPE_WARNING, "destroying peer %s\n", GNUNET_i2s (&id));
527 GNUNET_CONTAINER_multipeermap_remove (peers, &id, peer))
530 LOG (GNUNET_ERROR_TYPE_WARNING, " not in peermap!!\n");
532 if (NULL != peer->search_h)
534 GMD_search_stop (peer->search_h);
540 GNUNET_CONTAINER_DLL_remove (peer->path_head, peer->path_tail, p);
544 GMT_destroy_empty (peer->tunnel);
551 * Returns if peer is used (has a tunnel or is neighbor).
553 * @param peer Peer to check.
555 * @return #GNUNET_YES if peer is in use.
558 peer_is_used (struct MeshPeer *peer)
560 struct MeshPeerPath *p;
562 if (NULL != peer->tunnel)
565 for (p = peer->path_head; NULL != p; p = p->next)
575 * Iterator over all the peers to get the oldest timestamp.
577 * @param cls Closure (unsued).
578 * @param key ID of the peer.
579 * @param value Peer_Info of the peer.
582 peer_get_oldest (void *cls,
583 const struct GNUNET_PeerIdentity *key,
586 struct MeshPeer *p = value;
587 struct GNUNET_TIME_Absolute *abs = cls;
589 /* Don't count active peers */
590 if (GNUNET_YES == peer_is_used (p))
593 if (abs->abs_value_us < p->last_contact.abs_value_us)
594 abs->abs_value_us = p->last_contact.abs_value_us;
601 * Iterator over all the peers to remove the oldest entry.
603 * @param cls Closure (unsued).
604 * @param key ID of the peer.
605 * @param value Peer_Info of the peer.
608 peer_timeout (void *cls,
609 const struct GNUNET_PeerIdentity *key,
612 struct MeshPeer *p = value;
613 struct GNUNET_TIME_Absolute *abs = cls;
615 LOG (GNUNET_ERROR_TYPE_WARNING,
616 "peer %s timeout\n", GNUNET_i2s (key));
618 if (p->last_contact.abs_value_us == abs->abs_value_us &&
619 GNUNET_NO == peer_is_used (p))
629 * Delete oldest unused peer.
632 peer_delete_oldest (void)
634 struct GNUNET_TIME_Absolute abs;
636 abs = GNUNET_TIME_UNIT_FOREVER_ABS;
638 GNUNET_CONTAINER_multipeermap_iterate (peers,
641 GNUNET_CONTAINER_multipeermap_iterate (peers,
648 * Choose the best (yet unused) path towards a peer,
649 * considering the tunnel properties.
651 * @param peer The destination peer.
653 * @return Best current known path towards the peer, if any.
655 static struct MeshPeerPath *
656 peer_get_best_path (const struct MeshPeer *peer)
658 struct MeshPeerPath *best_p;
659 struct MeshPeerPath *p;
660 unsigned int best_cost;
663 best_cost = UINT_MAX;
665 for (p = peer->path_head; NULL != p; p = p->next)
667 if (GNUNET_YES == GMT_is_path_used (peer->tunnel, p))
668 continue; /* If path is already in use, skip it. */
670 if ((cost = GMT_get_path_cost (peer->tunnel, p)) < best_cost)
681 queue_is_sendable (struct MeshPeerQueue *q)
683 /* Is PID-independent? */
686 case GNUNET_MESSAGE_TYPE_MESH_ACK:
687 case GNUNET_MESSAGE_TYPE_MESH_POLL:
691 if (GMC_is_sendable (q->c, q->fwd))
699 * Get first sendable message.
701 * @param peer The destination peer.
703 * @return Best current known path towards the peer, if any.
705 static struct MeshPeerQueue *
706 peer_get_first_message (const struct MeshPeer *peer)
708 struct MeshPeerQueue *q;
710 for (q = peer->queue_head; NULL != q; q = q->next)
712 if (queue_is_sendable (q))
721 * Function to process paths received for a new peer addition. The recorded
722 * paths form the initial tunnel, which can be optimized later.
723 * Called on each result obtained for the DHT search.
729 search_handler (void *cls, const struct MeshPeerPath *path)
731 struct MeshPeer *peer = cls;
732 unsigned int connection_count;
734 GMP_add_path_to_all (path, GNUNET_NO);
736 /* Count connections */
737 connection_count = GMT_count_connections (peer->tunnel);
739 /* If we already have 3 (or more (?!)) connections, it's enough */
740 if (3 <= connection_count)
743 if (MESH_TUNNEL3_SEARCHING == GMT_get_cstate (peer->tunnel))
745 LOG (GNUNET_ERROR_TYPE_DEBUG, " ... connect!\n");
753 * Core callback to write a queued packet to core buffer
755 * @param cls Closure (peer info).
756 * @param size Number of bytes available in buf.
757 * @param buf Where the to write the message.
759 * @return number of bytes written to buf
761 * FIXME add GNUNET_MESSAGE_TYPE_MESH_KEEPALIVE
764 queue_send (void *cls, size_t size, void *buf)
766 struct MeshPeer *peer = cls;
767 struct MeshConnection *c;
768 struct MeshPeerQueue *queue;
769 const struct GNUNET_PeerIdentity *dst_id;
772 peer->core_transmit = NULL;
773 LOG (GNUNET_ERROR_TYPE_DEBUG, "* Queue send (max %u)\n", size);
775 if (NULL == buf || 0 == size)
777 LOG (GNUNET_ERROR_TYPE_DEBUG, "* Buffer size 0.\n");
782 queue = peer_get_first_message (peer);
785 GNUNET_break (0); /* Core tmt_rdy should've been canceled */
790 dst_id = GNUNET_PEER_resolve2 (peer->id);
791 LOG (GNUNET_ERROR_TYPE_DEBUG, "* towards %s\n", GNUNET_i2s (dst_id));
792 LOG (GNUNET_ERROR_TYPE_DEBUG, "* on connection %s\n", GMC_2s (c));
793 /* Check if buffer size is enough for the message */
794 if (queue->size > size)
796 LOG (GNUNET_ERROR_TYPE_DEBUG, "* not enough room, reissue\n");
797 peer->core_transmit =
798 GNUNET_CORE_notify_transmit_ready (core_handle,
801 GNUNET_TIME_UNIT_FOREVER_REL,
808 LOG (GNUNET_ERROR_TYPE_DEBUG, "* size %u ok\n", queue->size);
813 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY:
814 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN:
815 case GNUNET_MESSAGE_TYPE_MESH_KEEPALIVE:
816 case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
817 case GNUNET_MESSAGE_TYPE_MESH_KX:
818 case GNUNET_MESSAGE_TYPE_MESH_ACK:
819 case GNUNET_MESSAGE_TYPE_MESH_POLL:
820 LOG (GNUNET_ERROR_TYPE_DEBUG,
822 GM_m2s (queue->type));
823 data_size = send_core_data_raw (queue->cls, size, buf);
825 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE:
826 LOG (GNUNET_ERROR_TYPE_DEBUG, "* path create\n");
827 if (GMC_is_origin (c, GNUNET_YES))
828 data_size = send_core_connection_create (queue->c, size, buf);
830 data_size = send_core_data_raw (queue->cls, size, buf);
832 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK:
833 LOG (GNUNET_ERROR_TYPE_DEBUG, "* path ack\n");
834 if (GMC_is_origin (c, GNUNET_NO) ||
835 GMC_is_origin (c, GNUNET_YES))
836 data_size = send_core_connection_ack (queue->c, size, buf);
838 data_size = send_core_data_raw (queue->cls, size, buf);
840 case GNUNET_MESSAGE_TYPE_MESH_DATA:
841 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE:
842 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY:
843 /* This should be encapsulted */
849 LOG (GNUNET_ERROR_TYPE_WARNING, "* type unknown: %u\n", queue->type);
853 if (0 < drop_percent &&
854 GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 101) < drop_percent)
856 LOG (GNUNET_ERROR_TYPE_WARNING,
857 "Dropping message of type %s\n",
858 GM_m2s (queue->type));
862 /* Free queue, but cls was freed by send_core_* */
863 GMP_queue_destroy (queue, GNUNET_NO);
865 /* If more data in queue, send next */
866 queue = peer_get_first_message (peer);
869 LOG (GNUNET_ERROR_TYPE_DEBUG, "* more data!\n");
870 if (NULL == peer->core_transmit)
872 peer->core_transmit =
873 GNUNET_CORE_notify_transmit_ready(core_handle,
876 GNUNET_TIME_UNIT_FOREVER_REL,
881 queue->start_waiting = GNUNET_TIME_absolute_get ();
885 LOG (GNUNET_ERROR_TYPE_DEBUG,
886 "* tmt rdy called somewhere else\n");
888 // GMC_start_poll (); FIXME needed?
892 // GMC_stop_poll(); FIXME needed?
895 LOG (GNUNET_ERROR_TYPE_DEBUG, "* Return %d\n", data_size);
900 /******************************************************************************/
901 /******************************** API ***********************************/
902 /******************************************************************************/
906 * Free a transmission that was already queued with all resources
907 * associated to the request.
909 * @param queue Queue handler to cancel.
910 * @param clear_cls Is it necessary to free associated cls?
913 GMP_queue_destroy (struct MeshPeerQueue *queue, int clear_cls)
915 struct MeshPeer *peer;
918 GNUNET_assert (NULL != queue->c);
920 if (GNUNET_YES == clear_cls)
922 LOG (GNUNET_ERROR_TYPE_DEBUG, "# queue destroy type %s\n",
923 GM_m2s (queue->type));
926 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY:
927 LOG (GNUNET_ERROR_TYPE_INFO, "destroying a DESTROY message\n");
929 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK:
930 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE:
931 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN:
932 case GNUNET_MESSAGE_TYPE_MESH_KX:
933 case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
934 case GNUNET_MESSAGE_TYPE_MESH_ACK:
935 case GNUNET_MESSAGE_TYPE_MESH_POLL:
936 GNUNET_free_non_null (queue->cls);
941 LOG (GNUNET_ERROR_TYPE_ERROR, "# type %s unknown!\n",
942 GM_m2s (queue->type));
945 GNUNET_CONTAINER_DLL_remove (peer->queue_head, peer->queue_tail, queue);
947 if (queue->type != GNUNET_MESSAGE_TYPE_MESH_ACK &&
948 queue->type != GNUNET_MESSAGE_TYPE_MESH_POLL)
953 if (NULL != queue->callback)
955 LOG (GNUNET_ERROR_TYPE_DEBUG, "# Calling callback\n");
956 queue->callback (queue->callback_cls,
957 queue->c, queue->type,
958 queue->fwd, queue->size,
959 GNUNET_TIME_absolute_get_duration (queue->start_waiting));
967 * @brief Queue and pass message to core when possible.
969 * @param peer Peer towards which to queue the message.
970 * @param cls Closure (@c type dependant). It will be used by queue_send to
971 * build the message to be sent if not already prebuilt.
972 * @param type Type of the message, 0 for a raw message.
973 * @param size Size of the message.
974 * @param c Connection this message belongs to (cannot be NULL).
975 * @param fwd Is this a message going root->dest? (FWD ACK are NOT FWD!)
976 * @param cont Continuation to be called once CORE has taken the message.
977 * @param cont_cls Closure for @c cont.
979 * @return Handle to cancel the message before it is sent. Once cont is called
980 * message has been sent and therefore the handle is no longer valid.
982 struct MeshPeerQueue *
983 GMP_queue_add (struct MeshPeer *peer, void *cls, uint16_t type, size_t size,
984 struct MeshConnection *c, int fwd,
985 GMP_sent cont, void *cont_cls)
987 struct MeshPeerQueue *queue;
991 LOG (GNUNET_ERROR_TYPE_DEBUG,
992 "queue add %s %s towards %s (size %u) on c %p (%s)\n",
993 GM_f2s (fwd), GM_m2s (type), GMP_2s(peer),
994 size, c, GMC_2s (c));
995 GNUNET_assert (NULL != c);
997 if (NULL == peer->connections)
999 /* We are not connected to this peer, ignore request. */
1000 GNUNET_break_op (0);
1006 if (GNUNET_MESSAGE_TYPE_MESH_POLL == type ||
1007 GNUNET_MESSAGE_TYPE_MESH_ACK == type)
1012 LOG (GNUNET_ERROR_TYPE_DEBUG, "priority %d\n", priority);
1014 call_core = GMC_is_sendable (c, fwd);
1015 queue = GNUNET_malloc (sizeof (struct MeshPeerQueue));
1022 queue->callback = cont;
1023 queue->callback_cls = cont_cls;
1026 GNUNET_CONTAINER_DLL_insert_tail (peer->queue_head, peer->queue_tail, queue);
1031 GNUNET_CONTAINER_DLL_insert (peer->queue_head, peer->queue_tail, queue);
1032 call_core = GNUNET_YES;
1035 if (NULL == peer->core_transmit && GNUNET_YES == call_core)
1037 LOG (GNUNET_ERROR_TYPE_DEBUG,
1038 "calling core tmt rdy towards %s for %u bytes\n",
1039 GMP_2s (peer), size);
1040 peer->core_transmit =
1041 GNUNET_CORE_notify_transmit_ready (core_handle,
1044 GNUNET_TIME_UNIT_FOREVER_REL,
1045 GNUNET_PEER_resolve2 (peer->id),
1049 queue->start_waiting = GNUNET_TIME_absolute_get ();
1053 LOG (GNUNET_ERROR_TYPE_DEBUG,
1054 "core tmt rdy towards %s already called\n",
1063 * Cancel all queued messages to a peer that belong to a certain connection.
1065 * @param peer Peer towards whom to cancel.
1066 * @param c Connection whose queued messages to cancel. Might be destroyed by
1067 * the sent continuation call.
1070 GMP_queue_cancel (struct MeshPeer *peer, struct MeshConnection *c)
1072 struct MeshPeerQueue *q;
1073 struct MeshPeerQueue *next;
1074 struct MeshPeerQueue *prev;
1076 for (q = peer->queue_head; NULL != q; q = next)
1081 LOG (GNUNET_ERROR_TYPE_DEBUG,
1082 "GMP_cancel_queue %s\n",
1084 GMP_queue_destroy (q, GNUNET_YES);
1086 /* Get next from prev, q->next might be already freed:
1087 * queue destroy -> callback -> GMC_destroy -> cancel_queues -> here
1090 next = peer->queue_head;
1099 if (NULL == peer->queue_head)
1101 if (NULL != peer->core_transmit)
1103 GNUNET_CORE_notify_transmit_ready_cancel (peer->core_transmit);
1104 peer->core_transmit = NULL;
1111 * Get the first transmittable message for a connection.
1113 * @param peer Neighboring peer.
1114 * @param c Connection.
1116 * @return First transmittable message.
1118 static struct MeshPeerQueue *
1119 connection_get_first_message (struct MeshPeer *peer, struct MeshConnection *c)
1121 struct MeshPeerQueue *q;
1123 for (q = peer->queue_head; NULL != q; q = q->next)
1127 if (queue_is_sendable (q))
1129 LOG (GNUNET_ERROR_TYPE_DEBUG, " sendable!!\n");
1132 LOG (GNUNET_ERROR_TYPE_DEBUG, " not sendable\n");
1140 GMP_queue_unlock (struct MeshPeer *peer, struct MeshConnection *c)
1142 struct MeshPeerQueue *q;
1145 if (NULL != peer->core_transmit)
1147 LOG (GNUNET_ERROR_TYPE_DEBUG, " already unlocked!\n");
1148 return; /* Already unlocked */
1151 q = connection_get_first_message (peer, c);
1154 LOG (GNUNET_ERROR_TYPE_DEBUG, " queue empty!\n");
1155 return; /* Nothing to transmit */
1159 peer->core_transmit =
1160 GNUNET_CORE_notify_transmit_ready (core_handle,
1163 GNUNET_TIME_UNIT_FOREVER_REL,
1164 GNUNET_PEER_resolve2 (peer->id),
1172 * Initialize the peer subsystem.
1174 * @param c Configuration.
1177 GMP_init (const struct GNUNET_CONFIGURATION_Handle *c)
1179 LOG (GNUNET_ERROR_TYPE_DEBUG, "init\n");
1180 peers = GNUNET_CONTAINER_multipeermap_create (128, GNUNET_NO);
1182 GNUNET_CONFIGURATION_get_value_number (c, "MESH", "MAX_PEERS",
1185 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_WARNING,
1186 "MESH", "MAX_PEERS", "USING DEFAULT");
1191 GNUNET_CONFIGURATION_get_value_number (c, "MESH", "DROP_PERCENT",
1198 LOG (GNUNET_ERROR_TYPE_WARNING,
1199 "\n***************************************\n"
1200 "Mesh is running with drop mode enabled.\n"
1201 "This is NOT a good idea!\n"
1202 "Remove the DROP_PERCENT option from your configuration.\n"
1203 "***************************************\n");
1206 core_handle = GNUNET_CORE_connect (c, /* Main configuration */
1207 NULL, /* Closure passed to MESH functions */
1208 &core_init, /* Call core_init once connected */
1209 &core_connect, /* Handle connects */
1210 &core_disconnect, /* remove peers on disconnects */
1211 NULL, /* Don't notify about all incoming messages */
1212 GNUNET_NO, /* For header only in notification */
1213 NULL, /* Don't notify about all outbound messages */
1214 GNUNET_NO, /* For header-only out notification */
1215 core_handlers); /* Register these handlers */
1216 if (NULL == core_handle)
1219 GNUNET_SCHEDULER_shutdown ();
1225 * Shut down the peer subsystem.
1230 GNUNET_CONTAINER_multipeermap_iterate (peers, &shutdown_tunnel, NULL);
1232 if (core_handle != NULL)
1234 GNUNET_CORE_disconnect (core_handle);
1237 GNUNET_PEER_change_rc (myid, -1);
1241 * Retrieve the MeshPeer stucture associated with the peer, create one
1242 * and insert it in the appropriate structures if the peer is not known yet.
1244 * @param peer_id Full identity of the peer.
1246 * @return Existing or newly created peer structure.
1249 GMP_get (const struct GNUNET_PeerIdentity *peer_id)
1251 struct MeshPeer *peer;
1253 peer = GNUNET_CONTAINER_multipeermap_get (peers, peer_id);
1256 peer = GNUNET_new (struct MeshPeer);
1257 if (GNUNET_CONTAINER_multipeermap_size (peers) > max_peers)
1259 peer_delete_oldest ();
1261 GNUNET_CONTAINER_multipeermap_put (peers, peer_id, peer,
1262 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1263 peer->id = GNUNET_PEER_intern (peer_id);
1265 peer->last_contact = GNUNET_TIME_absolute_get();
1272 * Retrieve the MeshPeer stucture associated with the peer, create one
1273 * and insert it in the appropriate structures if the peer is not known yet.
1275 * @param peer Short identity of the peer.
1277 * @return Existing or newly created peer structure.
1280 GMP_get_short (const GNUNET_PEER_Id peer)
1282 return GMP_get (GNUNET_PEER_resolve2 (peer));
1287 * Try to establish a new connection to this peer (in its tunnel).
1288 * If the peer doesn't have any path to it yet, try to get one.
1289 * If the peer already has some path, send a CREATE CONNECTION towards it.
1291 * @param peer Peer to connect to.
1294 GMP_connect (struct MeshPeer *peer)
1296 struct MeshTunnel3 *t;
1297 struct MeshPeerPath *p;
1298 struct MeshConnection *c;
1301 LOG (GNUNET_ERROR_TYPE_DEBUG, "peer_connect towards %s\n", GMP_2s (peer));
1304 rerun_search = GNUNET_NO;
1306 if (NULL != peer->path_head)
1308 LOG (GNUNET_ERROR_TYPE_DEBUG, "path exists\n");
1309 p = peer_get_best_path (peer);
1312 LOG (GNUNET_ERROR_TYPE_DEBUG, " %u hops\n", p->length);
1313 c = GMT_use_path (t, p);
1316 /* This case can happen when the path includes a first hop that is
1317 * not yet known to be connected.
1319 * This happens quite often during testing when running mesh
1320 * under valgrind: core connect notifications come very late and the
1321 * DHT result has already come and created a valid path.
1322 * In this case, the peer->connections hashmap will be NULL and
1323 * tunnel_use_path will not be able to create a connection from that
1326 * Re-running the DHT GET should give core time to callback.
1329 rerun_search = GNUNET_YES;
1333 GMC_send_create (c);
1339 LOG (GNUNET_ERROR_TYPE_DEBUG, "but is NULL!!\n");
1344 if (NULL != peer->search_h && GNUNET_YES == rerun_search)
1346 GMD_search_stop (peer->search_h);
1347 peer->search_h = NULL;
1348 LOG (GNUNET_ERROR_TYPE_DEBUG,
1349 " Stopping DHT GET for peer %s\n",
1353 if (NULL == peer->search_h)
1355 const struct GNUNET_PeerIdentity *id;
1357 id = GNUNET_PEER_resolve2 (peer->id);
1358 LOG (GNUNET_ERROR_TYPE_DEBUG,
1359 " Starting DHT GET for peer %s\n", GMP_2s (peer));
1360 peer->search_h = GMD_search (id, &search_handler, peer);
1361 if (MESH_TUNNEL3_NEW == GMT_get_cstate (t))
1362 GMT_change_cstate (t, MESH_TUNNEL3_SEARCHING);
1374 GMP_set_tunnel (struct MeshPeer *peer, struct MeshTunnel3 *t)
1381 * Chech whether there is a direct (core level) connection to peer.
1383 * @param peer Peer to check.
1385 * @return #GNUNET_YES if there is a direct connection.
1388 GMP_is_neighbor (const struct MeshPeer *peer)
1390 struct MeshPeerPath *path;
1392 if (NULL == peer->connections)
1395 for (path = peer->path_head; NULL != path; path = path->next)
1397 if (3 > path->length)
1401 GNUNET_break (0); /* Is not a neighbor but connections is not NULL */
1407 * Create and initialize a new tunnel towards a peer, in case it has none.
1408 * In case the peer already has a tunnel, nothing is done.
1410 * Does not generate any traffic, just creates the local data structures.
1412 * @param peer Peer towards which to create the tunnel.
1415 GMP_add_tunnel (struct MeshPeer *peer)
1417 if (NULL != peer->tunnel)
1419 peer->tunnel = GMT_new (peer);
1424 * Add a connection to a neighboring peer.
1426 * Store that the peer is the first hop of the connection in one
1427 * direction and that on peer disconnect the connection must be
1428 * notified and destroyed, for it will no longer be valid.
1430 * @param peer Peer to add connection to.
1431 * @param c Connection to add.
1433 * @return GNUNET_OK on success.
1436 GMP_add_connection (struct MeshPeer *peer,
1437 struct MeshConnection *c)
1439 if (NULL == peer->connections)
1442 return GNUNET_SYSERR;
1444 return GNUNET_CONTAINER_multihashmap_put (peer->connections,
1447 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1452 * Add the path to the peer and update the path used to reach it in case this
1455 * @param peer Destination peer to add the path to.
1456 * @param path New path to add. Last peer must be the peer in arg 1.
1457 * Path will be either used of freed if already known.
1458 * @param trusted Do we trust that this path is real?
1460 * @return path if path was taken, pointer to existing duplicate if exists
1463 struct MeshPeerPath *
1464 GMP_add_path (struct MeshPeer *peer, struct MeshPeerPath *path,
1467 struct MeshPeerPath *aux;
1471 LOG (GNUNET_ERROR_TYPE_DEBUG, "adding path [%u] to peer %s\n",
1472 path->length, GMP_2s (peer));
1474 if ((NULL == peer) || (NULL == path))
1477 path_destroy (path);
1480 if (path->peers[path->length - 1] != peer->id)
1483 path_destroy (path);
1486 if (2 >= path->length && GNUNET_NO == trusted)
1488 /* Only allow CORE to tell us about direct paths */
1489 path_destroy (path);
1492 for (l = 1; l < path->length; l++)
1494 if (path->peers[l] == myid)
1496 LOG (GNUNET_ERROR_TYPE_DEBUG, "shortening path by %u\n", l);
1497 for (l2 = 0; l2 < path->length - l; l2++)
1499 path->peers[l2] = path->peers[l + l2];
1503 path->peers = GNUNET_realloc (path->peers,
1504 path->length * sizeof (GNUNET_PEER_Id));
1508 LOG (GNUNET_ERROR_TYPE_DEBUG, "adding path [%u]\n", path->length);
1510 l = path_get_length (path);
1513 path_destroy (path);
1517 GNUNET_assert (peer->id == path->peers[path->length - 1]);
1518 for (aux = peer->path_head; aux != NULL; aux = aux->next)
1520 l2 = path_get_length (aux);
1523 LOG (GNUNET_ERROR_TYPE_DEBUG, " added\n");
1524 GNUNET_CONTAINER_DLL_insert_before (peer->path_head,
1525 peer->path_tail, aux, path);
1530 if (l2 == l && memcmp (path->peers, aux->peers, l) == 0)
1532 LOG (GNUNET_ERROR_TYPE_DEBUG, " already known\n");
1533 path_destroy (path);
1538 GNUNET_CONTAINER_DLL_insert_tail (peer->path_head, peer->path_tail,
1540 LOG (GNUNET_ERROR_TYPE_DEBUG, " added last\n");
1546 * Add the path to the origin peer and update the path used to reach it in case
1547 * this is the shortest.
1548 * The path is given in peer_info -> destination, therefore we turn the path
1549 * upside down first.
1551 * @param peer Peer to add the path to, being the origin of the path.
1552 * @param path New path to add after being inversed.
1553 * Path will be either used or freed.
1554 * @param trusted Do we trust that this path is real?
1556 * @return path if path was taken, pointer to existing duplicate if exists
1559 struct MeshPeerPath *
1560 GMP_add_path_to_origin (struct MeshPeer *peer,
1561 struct MeshPeerPath *path,
1567 return GMP_add_path (peer, path, trusted);
1572 * Adds a path to the info of all the peers in the path
1574 * @param p Path to process.
1575 * @param confirmed Whether we know if the path works or not.
1578 GMP_add_path_to_all (const struct MeshPeerPath *p, int confirmed)
1582 /* TODO: invert and add */
1583 for (i = 0; i < p->length && p->peers[i] != myid; i++) /* skip'em */ ;
1584 for (i++; i < p->length; i++)
1586 struct MeshPeer *aux;
1587 struct MeshPeerPath *copy;
1589 aux = GMP_get_short (p->peers[i]);
1590 copy = path_duplicate (p);
1591 copy->length = i + 1;
1592 GMP_add_path (aux, copy, p->length < 3 ? GNUNET_NO : confirmed);
1598 * Remove any path to the peer that has the extact same peers as the one given.
1600 * @param peer Peer to remove the path from.
1601 * @param path Path to remove.
1604 GMP_remove_path (struct MeshPeer *peer, struct MeshPeerPath *path)
1606 struct MeshPeerPath *iter;
1607 struct MeshPeerPath *next;
1609 GNUNET_assert (myid == path->peers[0]);
1610 GNUNET_assert (peer->id == path->peers[path->length - 1]);
1612 for (iter = peer->path_head; NULL != iter; iter = next)
1615 if (0 == memcmp (path->peers, iter->peers,
1616 sizeof (GNUNET_PEER_Id) * path->length))
1618 path_destroy (iter);
1627 * Remove a connection from a neighboring peer.
1629 * @param peer Peer to remove connection from.
1630 * @param c Connection to remove.
1632 * @return GNUNET_OK on success.
1635 GMP_remove_connection (struct MeshPeer *peer,
1636 const struct MeshConnection *c)
1638 if (NULL == peer || NULL == peer->connections)
1640 LOG (GNUNET_ERROR_TYPE_DEBUG,
1641 "Peer %s is not a neighbor!\n",
1643 return GNUNET_SYSERR;
1645 return GNUNET_CONTAINER_multihashmap_remove (peer->connections,
1651 * Start the DHT search for new paths towards the peer: we don't have
1652 * enough good connections.
1654 * @param peer Destination peer.
1657 GMP_start_search (struct MeshPeer *peer)
1659 if (NULL != peer->search_h)
1665 peer->search_h = GMD_search (GMP_get_id (peer), &search_handler, peer);
1670 * Stop the DHT search for new paths towards the peer: we already have
1671 * enough good connections.
1673 * @param peer Destination peer.
1676 GMP_stop_search (struct MeshPeer *peer)
1678 if (NULL == peer->search_h)
1684 GMD_search_stop (peer->search_h);
1685 peer->search_h = NULL;
1690 * Get the Full ID of a peer.
1692 * @param peer Peer to get from.
1694 * @return Full ID of peer.
1696 const struct GNUNET_PeerIdentity *
1697 GMP_get_id (const struct MeshPeer *peer)
1699 return GNUNET_PEER_resolve2 (peer->id);
1704 * Get the Short ID of a peer.
1706 * @param peer Peer to get from.
1708 * @return Short ID of peer.
1711 GMP_get_short_id (const struct MeshPeer *peer)
1718 * Get the tunnel towards a peer.
1720 * @param peer Peer to get from.
1722 * @return Tunnel towards peer.
1724 struct MeshTunnel3 *
1725 GMP_get_tunnel (const struct MeshPeer *peer)
1727 GNUNET_assert (NULL != peer->tunnel);
1728 return peer->tunnel;
1733 * Get the static string for a peer ID.
1737 * @return Static string for it's ID.
1740 GMP_2s (const struct MeshPeer *peer)
1744 return GNUNET_i2s (GNUNET_PEER_resolve2 (peer->id));