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_enc.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 pi = GNUNET_CONTAINER_multipeermap_get (peers, peer);
290 GNUNET_CONTAINER_multihashmap_iterate (pi->connections, ¬ify_broken, pi);
291 GNUNET_CONTAINER_multihashmap_destroy (pi->connections);
292 pi->connections = NULL;
293 if (NULL != pi->core_transmit)
295 GNUNET_CORE_notify_transmit_ready_cancel (pi->core_transmit);
296 pi->core_transmit = NULL;
300 LOG (GNUNET_ERROR_TYPE_DEBUG, " (self)\n");
302 GNUNET_STATISTICS_update (stats, "# peers", -1, GNUNET_NO);
309 * Functions to handle messages from core
311 static struct GNUNET_CORE_MessageHandler core_handlers[] = {
312 {&GMC_handle_create, GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE,
314 {&GMC_handle_confirm, GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK,
315 sizeof (struct GNUNET_MESH_ConnectionACK)},
316 {&GMC_handle_broken, GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN,
317 sizeof (struct GNUNET_MESH_ConnectionBroken)},
318 {&GMC_handle_destroy, GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY,
319 sizeof (struct GNUNET_MESH_ConnectionDestroy)},
320 {&GMC_handle_keepalive, GNUNET_MESSAGE_TYPE_MESH_FWD_KEEPALIVE,
321 sizeof (struct GNUNET_MESH_ConnectionKeepAlive)},
322 {&GMC_handle_keepalive, GNUNET_MESSAGE_TYPE_MESH_BCK_KEEPALIVE,
323 sizeof (struct GNUNET_MESH_ConnectionKeepAlive)},
324 {&GMC_handle_ack, GNUNET_MESSAGE_TYPE_MESH_ACK,
325 sizeof (struct GNUNET_MESH_ACK)},
326 {&GMC_handle_poll, GNUNET_MESSAGE_TYPE_MESH_POLL,
327 sizeof (struct GNUNET_MESH_Poll)},
328 {&GMC_handle_encrypted, GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED, 0},
329 {&GMC_handle_kx, GNUNET_MESSAGE_TYPE_MESH_KX, 0},
335 * To be called on core init/fail.
337 * @param cls Closure (config)
338 * @param identity the public identity of this peer
341 core_init (void *cls,
342 const struct GNUNET_PeerIdentity *identity)
344 const struct GNUNET_CONFIGURATION_Handle *c = cls;
347 LOG (GNUNET_ERROR_TYPE_DEBUG, "Core init\n");
348 if (0 != memcmp (identity, &my_full_id, sizeof (my_full_id)))
350 LOG (GNUNET_ERROR_TYPE_ERROR, _("Wrong CORE service\n"));
351 LOG (GNUNET_ERROR_TYPE_ERROR, " core id %s\n", GNUNET_i2s (identity));
352 LOG (GNUNET_ERROR_TYPE_ERROR, " my id %s\n", GNUNET_i2s (&my_full_id));
353 GNUNET_CORE_disconnect (core_handle);
354 core_handle = GNUNET_CORE_connect (c, /* Main configuration */
355 NULL, /* Closure passed to MESH functions */
356 &core_init, /* Call core_init once connected */
357 &core_connect, /* Handle connects */
358 &core_disconnect, /* remove peers on disconnects */
359 NULL, /* Don't notify about all incoming messages */
360 GNUNET_NO, /* For header only in notification */
361 NULL, /* Don't notify about all outbound messages */
362 GNUNET_NO, /* For header-only out notification */
363 core_handlers); /* Register these handlers */
372 * Core callback to write a pre-constructed data packet to core buffer
374 * @param cls Closure (MeshTransmissionDescriptor with data in "data" member).
375 * @param size Number of bytes available in buf.
376 * @param buf Where the to write the message.
378 * @return number of bytes written to buf
381 send_core_data_raw (void *cls, size_t size, void *buf)
383 struct GNUNET_MessageHeader *msg = cls;
386 GNUNET_assert (NULL != msg);
387 total_size = ntohs (msg->size);
389 if (total_size > size)
394 memcpy (buf, msg, total_size);
401 * Function to send a create connection message to a peer.
403 * @param c Connection to create.
404 * @param size number of bytes available in buf
405 * @param buf where the callee should write the message
406 * @return number of bytes written to buf
409 send_core_connection_create (struct MeshConnection *c, size_t size, void *buf)
411 struct GNUNET_MESH_ConnectionCreate *msg;
412 struct GNUNET_PeerIdentity *peer_ptr;
413 const struct MeshPeerPath *p = GMC_get_path (c);
417 LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending CONNECTION CREATE...\n");
419 sizeof (struct GNUNET_MESH_ConnectionCreate) +
420 p->length * sizeof (struct GNUNET_PeerIdentity);
422 if (size < size_needed || NULL == buf)
427 msg = (struct GNUNET_MESH_ConnectionCreate *) buf;
428 msg->header.size = htons (size_needed);
429 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE);
430 msg->cid = *GMC_get_id (c);
432 peer_ptr = (struct GNUNET_PeerIdentity *) &msg[1];
433 for (i = 0; i < p->length; i++)
435 GNUNET_PEER_resolve (p->peers[i], peer_ptr++);
438 LOG (GNUNET_ERROR_TYPE_DEBUG,
439 "CONNECTION CREATE (%u bytes long) sent!\n",
446 * Creates a path ack message in buf and frees all unused resources.
448 * @param c Connection to send an ACK on.
449 * @param size number of bytes available in buf
450 * @param buf where the callee should write the message
452 * @return number of bytes written to buf
455 send_core_connection_ack (struct MeshConnection *c, size_t size, void *buf)
457 struct GNUNET_MESH_ConnectionACK *msg = buf;
459 LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending CONNECTION ACK...\n");
460 if (sizeof (struct GNUNET_MESH_ConnectionACK) > size)
465 msg->header.size = htons (sizeof (struct GNUNET_MESH_ConnectionACK));
466 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK);
467 msg->cid = *GMC_get_id (c);
470 /* TODO add signature */
472 LOG (GNUNET_ERROR_TYPE_DEBUG, "CONNECTION ACK sent!\n");
473 return sizeof (struct GNUNET_MESH_ConnectionACK);
477 /******************************************************************************/
478 /******************************** STATIC ***********************************/
479 /******************************************************************************/
482 * Iterator over tunnel hash map entries to destroy the tunnel during shutdown.
485 * @param key current key code
486 * @param value value in the hash map
487 * @return #GNUNET_YES if we should continue to iterate,
491 shutdown_tunnel (void *cls,
492 const struct GNUNET_PeerIdentity *key,
495 struct MeshPeer *p = value;
496 struct MeshTunnel3 *t = p->tunnel;
506 * Destroy the peer_info and free any allocated resources linked to it
508 * @param peer The peer_info to destroy.
510 * @return GNUNET_OK on success
513 peer_destroy (struct MeshPeer *peer)
515 struct GNUNET_PeerIdentity id;
516 struct MeshPeerPath *p;
517 struct MeshPeerPath *nextp;
519 GNUNET_PEER_resolve (peer->id, &id);
520 GNUNET_PEER_change_rc (peer->id, -1);
523 GNUNET_CONTAINER_multipeermap_remove (peers, &id, peer))
526 LOG (GNUNET_ERROR_TYPE_WARNING,
527 "removing peer %s, not in peermap\n", GNUNET_i2s (&id));
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 if (p->last_contact.abs_value_us == abs->abs_value_us &&
613 GNUNET_NO == peer_is_used (p))
623 * Delete oldest unused peer.
626 peer_delete_oldest (void)
628 struct GNUNET_TIME_Absolute abs;
630 abs = GNUNET_TIME_UNIT_FOREVER_ABS;
632 GNUNET_CONTAINER_multipeermap_iterate (peers,
635 GNUNET_CONTAINER_multipeermap_iterate (peers,
642 * Choose the best path towards a peer considering the tunnel properties.
644 * @param peer The destination peer.
646 * @return Best current known path towards the peer, if any.
648 static struct MeshPeerPath *
649 peer_get_best_path (const struct MeshPeer *peer)
651 struct MeshPeerPath *best_p;
652 struct MeshPeerPath *p;
653 unsigned int best_cost;
656 best_cost = UINT_MAX;
658 for (p = peer->path_head; NULL != p; p = p->next)
660 if (GNUNET_YES == GMT_is_path_used (peer->tunnel, p))
661 continue; /* If path is already in use, skip it. */
663 if ((cost = GMT_get_path_cost (peer->tunnel, p)) < best_cost)
674 queue_is_sendable (struct MeshPeerQueue *q)
676 /* Is PID-independent? */
679 case GNUNET_MESSAGE_TYPE_MESH_ACK:
680 case GNUNET_MESSAGE_TYPE_MESH_POLL:
684 if (GMC_is_sendable (q->c, q->fwd))
692 * Get first sendable message.
694 * @param peer The destination peer.
696 * @return Best current known path towards the peer, if any.
698 static struct MeshPeerQueue *
699 peer_get_first_message (const struct MeshPeer *peer)
701 struct MeshPeerQueue *q;
703 for (q = peer->queue_head; NULL != q; q = q->next)
705 if (queue_is_sendable (q))
714 * Function to process paths received for a new peer addition. The recorded
715 * paths form the initial tunnel, which can be optimized later.
716 * Called on each result obtained for the DHT search.
722 search_handler (void *cls, const struct MeshPeerPath *path)
724 struct MeshPeer *peer = cls;
725 unsigned int connection_count;
727 GMP_add_path_to_all (path, GNUNET_NO);
729 /* Count connections */
730 connection_count = GMT_count_connections (peer->tunnel);
732 /* If we already have 3 (or more (?!)) connections, it's enough */
733 if (3 <= connection_count)
736 if (MESH_TUNNEL3_SEARCHING == GMT_get_state (peer->tunnel))
738 LOG (GNUNET_ERROR_TYPE_DEBUG, " ... connect!\n");
746 * Free a transmission that was already queued with all resources
747 * associated to the request.
749 * @param queue Queue handler to cancel.
750 * @param clear_cls Is it necessary to free associated cls?
753 queue_destroy (struct MeshPeerQueue *queue, int clear_cls)
755 struct MeshPeer *peer;
758 GNUNET_assert (NULL != queue->c);
760 if (GNUNET_YES == clear_cls)
762 LOG (GNUNET_ERROR_TYPE_DEBUG, "# queue destroy type %s\n",
763 GNUNET_MESH_DEBUG_M2S (queue->type));
766 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY:
767 case GNUNET_MESSAGE_TYPE_MESH_TUNNEL_DESTROY:
768 LOG (GNUNET_ERROR_TYPE_INFO, "destroying a DESTROY message\n");
770 case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
771 case GNUNET_MESSAGE_TYPE_MESH_ACK:
772 case GNUNET_MESSAGE_TYPE_MESH_POLL:
773 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK:
774 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE:
775 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN:
776 LOG (GNUNET_ERROR_TYPE_DEBUG, "# prebuilt message\n");;
777 GNUNET_free_non_null (queue->cls);
782 LOG (GNUNET_ERROR_TYPE_ERROR, "# type %s unknown!\n",
783 GNUNET_MESH_DEBUG_M2S (queue->type));
786 GNUNET_CONTAINER_DLL_remove (peer->queue_head, peer->queue_tail, queue);
788 if (queue->type != GNUNET_MESSAGE_TYPE_MESH_ACK &&
789 queue->type != GNUNET_MESSAGE_TYPE_MESH_POLL)
794 if (NULL != queue->callback)
796 LOG (GNUNET_ERROR_TYPE_DEBUG, "# Calling callback\n");
797 queue->callback (queue->callback_cls,
798 queue->c, queue->type,
799 queue->fwd, queue->size,
800 GNUNET_TIME_absolute_get_duration (queue->start_waiting));
807 * Core callback to write a queued packet to core buffer
809 * @param cls Closure (peer info).
810 * @param size Number of bytes available in buf.
811 * @param buf Where the to write the message.
813 * @return number of bytes written to buf
816 queue_send (void *cls, size_t size, void *buf)
818 struct MeshPeer *peer = cls;
819 struct MeshConnection *c;
820 struct MeshPeerQueue *queue;
821 const struct GNUNET_PeerIdentity *dst_id;
824 peer->core_transmit = NULL;
825 LOG (GNUNET_ERROR_TYPE_DEBUG, "* Queue send (max %u)\n", size);
827 if (NULL == buf || 0 == size)
829 LOG (GNUNET_ERROR_TYPE_DEBUG, "* Buffer size 0.\n");
834 queue = peer_get_first_message (peer);
837 GNUNET_break (0); /* Core tmt_rdy should've been canceled */
842 dst_id = GNUNET_PEER_resolve2 (peer->id);
843 LOG (GNUNET_ERROR_TYPE_DEBUG, "* towards %s\n", GNUNET_i2s (dst_id));
844 /* Check if buffer size is enough for the message */
845 if (queue->size > size)
847 LOG (GNUNET_ERROR_TYPE_DEBUG, "* not enough room, reissue\n");
848 peer->core_transmit =
849 GNUNET_CORE_notify_transmit_ready (core_handle,
852 GNUNET_TIME_UNIT_FOREVER_REL,
859 LOG (GNUNET_ERROR_TYPE_DEBUG, "* size %u ok\n", queue->size);
864 case GNUNET_MESSAGE_TYPE_MESH_TUNNEL_DESTROY:
865 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY:
866 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN:
867 case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
868 case GNUNET_MESSAGE_TYPE_MESH_KX:
869 case GNUNET_MESSAGE_TYPE_MESH_ACK:
870 case GNUNET_MESSAGE_TYPE_MESH_POLL:
871 LOG (GNUNET_ERROR_TYPE_DEBUG,
873 GNUNET_MESH_DEBUG_M2S (queue->type));
874 data_size = send_core_data_raw (queue->cls, size, buf);
876 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE:
877 LOG (GNUNET_ERROR_TYPE_DEBUG, "* path create\n");
878 if (GMC_is_origin (c, GNUNET_YES))
879 data_size = send_core_connection_create (queue->c, size, buf);
881 data_size = send_core_data_raw (queue->cls, size, buf);
883 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK:
884 LOG (GNUNET_ERROR_TYPE_DEBUG, "* path ack\n");
885 if (GMC_is_origin (c, GNUNET_NO) ||
886 GMC_is_origin (c, GNUNET_YES))
887 data_size = send_core_connection_ack (queue->c, size, buf);
889 data_size = send_core_data_raw (queue->cls, size, buf);
891 case GNUNET_MESSAGE_TYPE_MESH_DATA:
892 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE:
893 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY:
894 /* This should be encapsulted */
900 LOG (GNUNET_ERROR_TYPE_WARNING, "* type unknown: %u\n",
905 if (0 < drop_percent &&
906 GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 101) < drop_percent)
908 LOG (GNUNET_ERROR_TYPE_WARNING,
909 "Dropping message of type %s\n",
910 GNUNET_MESH_DEBUG_M2S (queue->type));
914 /* Free queue, but cls was freed by send_core_* */
915 queue_destroy (queue, GNUNET_NO);
917 /* If more data in queue, send next */
918 queue = peer_get_first_message (peer);
921 LOG (GNUNET_ERROR_TYPE_DEBUG, "* more data!\n");
922 if (NULL == peer->core_transmit)
924 peer->core_transmit =
925 GNUNET_CORE_notify_transmit_ready(core_handle,
928 GNUNET_TIME_UNIT_FOREVER_REL,
933 queue->start_waiting = GNUNET_TIME_absolute_get ();
937 LOG (GNUNET_ERROR_TYPE_DEBUG,
938 "* tmt rdy called somewhere else\n");
940 // GMC_start_poll (); FIXME needed?
944 // GMC_stop_poll(); FIXME needed?
947 LOG (GNUNET_ERROR_TYPE_DEBUG, "* Return %d\n", data_size);
952 /******************************************************************************/
953 /******************************** API ***********************************/
954 /******************************************************************************/
957 * @brief Queue and pass message to core when possible.
959 * @param peer Peer towards which to queue the message.
960 * @param cls Closure (@c type dependant). It will be used by queue_send to
961 * build the message to be sent if not already prebuilt.
962 * @param type Type of the message, 0 for a raw message.
963 * @param size Size of the message.
964 * @param c Connection this message belongs to (cannot be NULL).
965 * @param fwd Is this a message going root->dest? (FWD ACK are NOT FWD!)
966 * @param cont Continuation to be called once CORE has taken the message.
967 * @param cont_cls Closure for @c cont.
970 GMP_queue_add (struct MeshPeer *peer, void *cls, uint16_t type, size_t size,
971 struct MeshConnection *c, int fwd,
972 GMP_sent cont, void *cont_cls)
974 struct MeshPeerQueue *queue;
978 LOG (GNUNET_ERROR_TYPE_DEBUG,
979 "queue add %s %s towards %s (size %u) on c %p (%s)\n",
980 fwd ? "FWD" : "BCK", GNUNET_MESH_DEBUG_M2S (type), GMP_2s(peer),
981 size, c, GMC_2s (c));
982 GNUNET_assert (NULL != c);
984 if (NULL == peer->connections)
986 /* We are not connected to this peer, ignore request. */
993 if (GNUNET_MESSAGE_TYPE_MESH_POLL == type ||
994 GNUNET_MESSAGE_TYPE_MESH_ACK == type)
999 LOG (GNUNET_ERROR_TYPE_DEBUG, "priority %d\n", priority);
1001 call_core = GMC_is_sendable (c, fwd);
1002 queue = GNUNET_malloc (sizeof (struct MeshPeerQueue));
1009 queue->callback = cont;
1010 queue->callback_cls = cont_cls;
1011 if (100 <= priority)
1013 struct MeshPeerQueue *copy;
1014 struct MeshPeerQueue *next;
1016 for (copy = peer->queue_head; NULL != copy; copy = next)
1019 if (copy->type == type && copy->c == c && copy->fwd == fwd)
1021 /* Example: also a FWD ACK for connection XYZ */
1022 queue_destroy (copy, GNUNET_YES);
1025 GNUNET_CONTAINER_DLL_insert (peer->queue_head, peer->queue_tail, queue);
1029 GNUNET_CONTAINER_DLL_insert_tail (peer->queue_head, peer->queue_tail, queue);
1033 if (NULL == peer->core_transmit && GNUNET_YES == call_core)
1035 LOG (GNUNET_ERROR_TYPE_DEBUG,
1036 "calling core tmt rdy towards %s for %u bytes\n",
1037 GMP_2s (peer), size);
1038 peer->core_transmit =
1039 GNUNET_CORE_notify_transmit_ready (core_handle,
1042 GNUNET_TIME_UNIT_FOREVER_REL,
1043 GNUNET_PEER_resolve2 (peer->id),
1047 queue->start_waiting = GNUNET_TIME_absolute_get ();
1051 LOG (GNUNET_ERROR_TYPE_DEBUG,
1052 "core tmt rdy towards %s already called\n",
1060 * Cancel all queued messages to a peer that belong to a certain connection.
1062 * @param peer Peer towards whom to cancel.
1063 * @param c Connection whose queued messages to cancel. Might be destroyed by
1064 * the sent continuation call.
1067 GMP_queue_cancel (struct MeshPeer *peer, struct MeshConnection *c)
1069 struct MeshPeerQueue *q;
1070 struct MeshPeerQueue *next;
1071 struct MeshPeerQueue *prev;
1073 for (q = peer->queue_head; NULL != q; q = next)
1078 LOG (GNUNET_ERROR_TYPE_DEBUG,
1079 "GMP_cancel_queue %s\n",
1080 GNUNET_MESH_DEBUG_M2S (q->type));
1081 queue_destroy (q, GNUNET_YES);
1083 /* Get next from prev, q->next might be already freed:
1084 * queue destroy -> callback -> GMC_destroy -> cancel_queues -> here
1087 next = peer->queue_head;
1096 if (NULL == peer->queue_head)
1098 if (NULL != peer->core_transmit)
1100 GNUNET_CORE_notify_transmit_ready_cancel (peer->core_transmit);
1101 peer->core_transmit = NULL;
1108 * Get the first transmittable message for a connection.
1110 * @param peer Neighboring peer.
1111 * @param c Connection.
1113 * @return First transmittable message.
1115 static struct MeshPeerQueue *
1116 connection_get_first_message (struct MeshPeer *peer, struct MeshConnection *c)
1118 struct MeshPeerQueue *q;
1120 for (q = peer->queue_head; NULL != q; q = q->next)
1124 if (queue_is_sendable (q))
1132 GMP_queue_unlock (struct MeshPeer *peer, struct MeshConnection *c)
1134 struct MeshPeerQueue *q;
1137 if (NULL != peer->core_transmit)
1139 LOG (GNUNET_ERROR_TYPE_DEBUG, " already unlocked!\n");
1140 return; /* Already unlocked */
1143 q = connection_get_first_message (peer, c);
1146 LOG (GNUNET_ERROR_TYPE_DEBUG, " queue empty!\n");
1147 return; /* Nothing to transmit */
1151 peer->core_transmit =
1152 GNUNET_CORE_notify_transmit_ready (core_handle,
1155 GNUNET_TIME_UNIT_FOREVER_REL,
1156 GNUNET_PEER_resolve2 (peer->id),
1164 * Initialize the peer subsystem.
1166 * @param c Configuration.
1169 GMP_init (const struct GNUNET_CONFIGURATION_Handle *c)
1171 LOG (GNUNET_ERROR_TYPE_DEBUG, "init\n");
1172 peers = GNUNET_CONTAINER_multipeermap_create (128, GNUNET_NO);
1174 GNUNET_CONFIGURATION_get_value_number (c, "MESH", "MAX_PEERS",
1177 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_WARNING,
1178 "MESH", "MAX_PEERS", "USING DEFAULT");
1183 GNUNET_CONFIGURATION_get_value_number (c, "MESH", "DROP_PERCENT",
1190 LOG (GNUNET_ERROR_TYPE_WARNING,
1191 "\n***************************************\n"
1192 "Mesh is running with drop mode enabled.\n"
1193 "This is NOT a good idea!\n"
1194 "Remove the DROP_PERCENT option from your configuration.\n"
1195 "***************************************\n");
1198 core_handle = GNUNET_CORE_connect (c, /* Main configuration */
1199 NULL, /* Closure passed to MESH functions */
1200 &core_init, /* Call core_init once connected */
1201 &core_connect, /* Handle connects */
1202 &core_disconnect, /* remove peers on disconnects */
1203 NULL, /* Don't notify about all incoming messages */
1204 GNUNET_NO, /* For header only in notification */
1205 NULL, /* Don't notify about all outbound messages */
1206 GNUNET_NO, /* For header-only out notification */
1207 core_handlers); /* Register these handlers */
1208 if (NULL == core_handle)
1211 GNUNET_SCHEDULER_shutdown ();
1217 * Shut down the peer subsystem.
1222 GNUNET_CONTAINER_multipeermap_iterate (peers, &shutdown_tunnel, NULL);
1224 if (core_handle != NULL)
1226 GNUNET_CORE_disconnect (core_handle);
1229 GNUNET_PEER_change_rc (myid, -1);
1233 * Retrieve the MeshPeer stucture associated with the peer, create one
1234 * and insert it in the appropriate structures if the peer is not known yet.
1236 * @param peer_id Full identity of the peer.
1238 * @return Existing or newly created peer structure.
1241 GMP_get (const struct GNUNET_PeerIdentity *peer_id)
1243 struct MeshPeer *peer;
1245 peer = GNUNET_CONTAINER_multipeermap_get (peers, peer_id);
1248 peer = GNUNET_new (struct MeshPeer);
1249 if (GNUNET_CONTAINER_multipeermap_size (peers) > max_peers)
1251 peer_delete_oldest ();
1253 GNUNET_CONTAINER_multipeermap_put (peers, peer_id, peer,
1254 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1255 peer->id = GNUNET_PEER_intern (peer_id);
1257 peer->last_contact = GNUNET_TIME_absolute_get();
1264 * Retrieve the MeshPeer stucture associated with the peer, create one
1265 * and insert it in the appropriate structures if the peer is not known yet.
1267 * @param peer Short identity of the peer.
1269 * @return Existing or newly created peer structure.
1272 GMP_get_short (const GNUNET_PEER_Id peer)
1274 return GMP_get (GNUNET_PEER_resolve2 (peer));
1279 * Try to establish a new connection to this peer (in its tunnel).
1280 * If the peer doesn't have any path to it yet, try to get one.
1281 * If the peer already has some path, send a CREATE CONNECTION towards it.
1283 * @param peer Peer to connect to.
1286 GMP_connect (struct MeshPeer *peer)
1288 struct MeshTunnel3 *t;
1289 struct MeshPeerPath *p;
1290 struct MeshConnection *c;
1293 LOG (GNUNET_ERROR_TYPE_DEBUG,
1294 "peer_connect towards %s\n",
1298 rerun_search = GNUNET_NO;
1300 if (NULL != peer->path_head)
1302 LOG (GNUNET_ERROR_TYPE_DEBUG, "path exists\n");
1303 p = peer_get_best_path (peer);
1306 LOG (GNUNET_ERROR_TYPE_DEBUG, " %u hops\n", p->length);
1307 c = GMT_use_path (t, p);
1310 /* This case can happen when the path includes a first hop that is
1311 * not yet known to be connected.
1313 * This happens quite often during testing when running mesh
1314 * under valgrind: core connect notifications come very late and the
1315 * DHT result has already come and created a valid path.
1316 * In this case, the peer->connections hashmap will be NULL and
1317 * tunnel_use_path will not be able to create a connection from that
1320 * Re-running the DHT GET should give core time to callback.
1323 rerun_search = GNUNET_YES;
1327 GMC_send_create (c);
1333 if (NULL != peer->search_h && GNUNET_YES == rerun_search)
1335 GMD_search_stop (peer->search_h);
1336 peer->search_h = NULL;
1337 LOG (GNUNET_ERROR_TYPE_DEBUG,
1338 " Stopping DHT GET for peer %s\n",
1342 if (NULL == peer->search_h)
1344 const struct GNUNET_PeerIdentity *id;
1346 id = GNUNET_PEER_resolve2 (peer->id);
1347 LOG (GNUNET_ERROR_TYPE_DEBUG,
1348 " Starting DHT GET for peer %s\n", GMP_2s (peer));
1349 peer->search_h = GMD_search (id, &search_handler, peer);
1350 if (MESH_TUNNEL3_NEW == GMT_get_state (t))
1351 GMT_change_state (t, MESH_TUNNEL3_SEARCHING);
1363 GMP_set_tunnel (struct MeshPeer *peer, struct MeshTunnel3 *t)
1370 * Chech whether there is a direct (core level) connection to peer.
1372 * @param peer Peer to check.
1374 * @return #GNUNET_YES if there is a direct connection.
1377 GMP_is_neighbor (const struct MeshPeer *peer)
1379 struct MeshPeerPath *path;
1381 if (NULL == peer->connections)
1384 for (path = peer->path_head; NULL != path; path = path->next)
1386 if (3 > path->length)
1390 GNUNET_break (0); /* Is not a neighbor but connections is not NULL */
1396 * Create and initialize a new tunnel towards a peer, in case it has none.
1397 * In case the peer already has a tunnel, nothing is done.
1399 * Does not generate any traffic, just creates the local data structures.
1401 * @param peer Peer towards which to create the tunnel.
1404 GMP_add_tunnel (struct MeshPeer *peer)
1406 if (NULL != peer->tunnel)
1408 peer->tunnel = GMT_new (peer);
1413 * Add a connection to a neighboring peer.
1415 * Store that the peer is the first hop of the connection in one
1416 * direction and that on peer disconnect the connection must be
1417 * notified and destroyed, for it will no longer be valid.
1419 * @param peer Peer to add connection to.
1420 * @param c Connection to add.
1422 * @return GNUNET_OK on success.
1425 GMP_add_connection (struct MeshPeer *peer,
1426 struct MeshConnection *c)
1428 if (NULL == peer->connections)
1431 return GNUNET_SYSERR;
1433 return GNUNET_CONTAINER_multihashmap_put (peer->connections,
1436 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1441 * Add the path to the peer and update the path used to reach it in case this
1444 * @param peer Destination peer to add the path to.
1445 * @param path New path to add. Last peer must be the peer in arg 1.
1446 * Path will be either used of freed if already known.
1447 * @param trusted Do we trust that this path is real?
1449 * @return path if path was taken, pointer to existing duplicate if exists
1452 struct MeshPeerPath *
1453 GMP_add_path (struct MeshPeer *peer, struct MeshPeerPath *path,
1456 struct MeshPeerPath *aux;
1460 LOG (GNUNET_ERROR_TYPE_DEBUG, "adding path [%u] to peer %s\n",
1461 path->length, GMP_2s (peer));
1463 if ((NULL == peer) || (NULL == path))
1466 path_destroy (path);
1469 if (path->peers[path->length - 1] != peer->id)
1472 path_destroy (path);
1475 if (2 >= path->length && GNUNET_NO == trusted)
1477 /* Only allow CORE to tell us about direct paths */
1478 path_destroy (path);
1481 for (l = 1; l < path->length; l++)
1483 if (path->peers[l] == myid)
1485 LOG (GNUNET_ERROR_TYPE_DEBUG, "shortening path by %u\n", l);
1486 for (l2 = 0; l2 < path->length - l; l2++)
1488 path->peers[l2] = path->peers[l + l2];
1492 path->peers = GNUNET_realloc (path->peers,
1493 path->length * sizeof (GNUNET_PEER_Id));
1497 LOG (GNUNET_ERROR_TYPE_DEBUG, "adding path [%u]\n", path->length);
1499 l = path_get_length (path);
1502 path_destroy (path);
1506 GNUNET_assert (peer->id == path->peers[path->length - 1]);
1507 for (aux = peer->path_head; aux != NULL; aux = aux->next)
1509 l2 = path_get_length (aux);
1512 LOG (GNUNET_ERROR_TYPE_DEBUG, " added\n");
1513 GNUNET_CONTAINER_DLL_insert_before (peer->path_head,
1514 peer->path_tail, aux, path);
1519 if (l2 == l && memcmp (path->peers, aux->peers, l) == 0)
1521 LOG (GNUNET_ERROR_TYPE_DEBUG, " already known\n");
1522 path_destroy (path);
1527 GNUNET_CONTAINER_DLL_insert_tail (peer->path_head, peer->path_tail,
1529 LOG (GNUNET_ERROR_TYPE_DEBUG, " added last\n");
1535 * Add the path to the origin peer and update the path used to reach it in case
1536 * this is the shortest.
1537 * The path is given in peer_info -> destination, therefore we turn the path
1538 * upside down first.
1540 * @param peer Peer to add the path to, being the origin of the path.
1541 * @param path New path to add after being inversed.
1542 * Path will be either used or freed.
1543 * @param trusted Do we trust that this path is real?
1545 * @return path if path was taken, pointer to existing duplicate if exists
1548 struct MeshPeerPath *
1549 GMP_add_path_to_origin (struct MeshPeer *peer,
1550 struct MeshPeerPath *path,
1556 return GMP_add_path (peer, path, trusted);
1561 * Adds a path to the info of all the peers in the path
1563 * @param p Path to process.
1564 * @param confirmed Whether we know if the path works or not.
1567 GMP_add_path_to_all (const struct MeshPeerPath *p, int confirmed)
1571 /* TODO: invert and add */
1572 for (i = 0; i < p->length && p->peers[i] != myid; i++) /* skip'em */ ;
1573 for (i++; i < p->length; i++)
1575 struct MeshPeer *aux;
1576 struct MeshPeerPath *copy;
1578 aux = GMP_get_short (p->peers[i]);
1579 copy = path_duplicate (p);
1580 copy->length = i + 1;
1581 GMP_add_path (aux, copy, p->length < 3 ? GNUNET_NO : confirmed);
1587 * Remove a connection from a neighboring peer.
1589 * @param peer Peer to remove connection from.
1590 * @param c Connection to remove.
1592 * @return GNUNET_OK on success.
1595 GMP_remove_connection (struct MeshPeer *peer,
1596 const struct MeshConnection *c)
1598 if (NULL == peer || NULL == peer->connections)
1601 LOG (GNUNET_ERROR_TYPE_DEBUG,
1602 "Peer %s is not a neighbor!\n",
1604 return GNUNET_SYSERR;
1606 return GNUNET_CONTAINER_multihashmap_remove (peer->connections,
1612 * Start the DHT search for new paths towards the peer: we don't have
1613 * enough good connections.
1615 * @param peer Destination peer.
1618 GMP_start_search (struct MeshPeer *peer)
1620 if (NULL != peer->search_h)
1626 peer->search_h = GMD_search (GMP_get_id (peer), &search_handler, peer);
1631 * Stop the DHT search for new paths towards the peer: we already have
1632 * enough good connections.
1634 * @param peer Destination peer.
1637 GMP_stop_search (struct MeshPeer *peer)
1639 if (NULL == peer->search_h)
1645 GMD_search_stop (peer->search_h);
1646 peer->search_h = NULL;
1651 * Get the Full ID of a peer.
1653 * @param peer Peer to get from.
1655 * @return Full ID of peer.
1657 const struct GNUNET_PeerIdentity *
1658 GMP_get_id (const struct MeshPeer *peer)
1660 return GNUNET_PEER_resolve2 (peer->id);
1665 * Get the Short ID of a peer.
1667 * @param peer Peer to get from.
1669 * @return Short ID of peer.
1672 GMP_get_short_id (const struct MeshPeer *peer)
1679 * Get the tunnel towards a peer.
1681 * @param peer Peer to get from.
1683 * @return Tunnel towards peer.
1685 struct MeshTunnel3 *
1686 GMP_get_tunnel (const struct MeshPeer *peer)
1688 return peer->tunnel;
1693 * Get the static string for a peer ID.
1697 * @return Static string for it's ID.
1700 GMP_2s (const struct MeshPeer *peer)
1704 return GNUNET_i2s (GNUNET_PEER_resolve2 (peer->id));