2 This file is part of GNUnet.
3 (C) 2009, 2010, 2011 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.
22 * @file core/gnunet-service-core_neighbours.c
23 * @brief code for managing low-level 'plaintext' connections with transport (key exchange may or may not be done yet)
24 * @author Christian Grothoff
27 #include "gnunet_util_lib.h"
28 #include "gnunet_transport_service.h"
29 #include "gnunet_service_core.h"
30 #include "gnunet_service_core_neighbours.h"
31 #include "gnunet_service_core_kx.h"
32 #include "gnunet_service_core_sessions.h"
36 * Message ready for transmission via transport service. This struct
37 * is followed by the actual content of the message.
43 * We keep messages in a doubly linked list.
45 struct MessageEntry *next;
48 * We keep messages in a doubly linked list.
50 struct MessageEntry *prev;
53 * By when are we supposed to transmit this message?
55 struct GNUNET_TIME_Absolute deadline;
58 * How long is the message? (number of bytes following the "struct
59 * MessageEntry", but not including the size of "struct
60 * MessageEntry" itself!)
68 * Data kept per transport-connected peer.
74 * Head of the batched message queue (already ordered, transmit
75 * starting with the head).
77 struct MessageEntry *message_head;
80 * Tail of the batched message queue (already ordered, append new
83 struct MessageEntry *message_tail;
86 * Handle for pending requests for transmission to this peer
87 * with the transport service. NULL if no request is pending.
89 struct GNUNET_TRANSPORT_TransmitHandle *th;
92 * Information about the key exchange with the other peer.
94 struct GSC_KeyExchangeInfo *kxinfo;
97 * Identity of the other peer.
99 struct GNUNET_PeerIdentity peer;
102 * ID of task used for re-trying plaintext scheduling.
104 GNUNET_SCHEDULER_TaskIdentifier retry_plaintext_task;
107 * Tracking bandwidth for sending to this peer.
109 struct GNUNET_BANDWIDTH_Tracker available_send_window;
112 * Tracking bandwidth for sending to this peer.
114 struct GNUNET_BANDWIDTH_Tracker available_recv_window;
120 * Map of peer identities to 'struct Neighbour'.
122 static struct GNUNET_CONTAINER_MultiHashMap *neighbours;
127 static struct GNUNET_TRANSPORT_Handle *transport;
131 * Find the entry for the given neighbour.
133 * @param peer identity of the neighbour
134 * @return NULL if we are not connected, otherwise the
137 static struct Neighbour *
138 find_neighbour (const struct GNUNET_PeerIdentity *peer)
140 return GNUNET_CONTAINER_multihashmap_get (neighbours, &peer->hashPubKey);
145 * Free the given entry for the neighbour.
147 * @param n neighbour to free
150 free_neighbour (struct Neighbour *n)
152 struct MessageEntry *m;
155 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
156 "Destroying neighbour entry for peer `%4s'\n",
157 GNUNET_i2s (&n->peer));
159 while (NULL != (m = n->message_head))
161 GNUNET_CONTAINER_DLL_remove (n->message_head, n->message_tail, m);
166 GNUNET_TRANSPORT_notify_transmit_ready_cancel (n->th);
169 GSC_SESSIONS_end (&n->peer);
175 if (n->retry_plaintext_task != GNUNET_SCHEDULER_NO_TASK)
177 GNUNET_SCHEDULER_cancel (n->retry_plaintext_task);
178 n->retry_plaintext_task = GNUNET_SCHEDULER_NO_TASK;
180 GNUNET_assert (GNUNET_OK ==
181 GNUNET_CONTAINER_multihashmap_remove (neighbours,
182 &n->peer.hashPubKey, n));
183 GNUNET_STATISTICS_set (stats, gettext_noop ("# neighbour entries allocated"),
184 GNUNET_CONTAINER_multihashmap_size (neighbours),
191 * Check if we have encrypted messages for the specified neighbour
192 * pending, and if so, check with the transport about sending them
195 * @param n neighbour to check.
198 process_queue (struct Neighbour *n);
202 * Function called when the transport service is ready to receive a
203 * message for the respective peer
205 * @param cls neighbour to use message from
206 * @param size number of bytes we can transmit
207 * @param buf where to copy the message
208 * @return number of bytes transmitted
211 transmit_ready (void *cls, size_t size, void *buf)
213 struct Neighbour *n = cls;
214 struct MessageEntry *m;
225 GNUNET_CONTAINER_DLL_remove (n->encrypted_head, n->encrypted_tail, m);
229 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
230 "Transmission of message of type %u and size %u failed\n",
232 ntohs (((struct GNUNET_MessageHeader *) &m[1])->type),
233 (unsigned int) m->size);
241 GNUNET_assert (size >= m->size);
242 memcpy (cbuf, &m[1], m->size);
244 GNUNET_BANDWIDTH_tracker_consume (&n->available_send_window, m->size);
246 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
247 "Copied message of type %u and size %u into transport buffer for `%4s'\n",
249 ntohs (((struct GNUNET_MessageHeader *) &m[1])->type),
250 (unsigned int) ret, GNUNET_i2s (&n->peer));
254 GNUNET_STATISTICS_update (GSC_stats,
256 ("# encrypted bytes given to transport"), ret,
263 * Check if we have messages for the specified neighbour pending, and
264 * if so, check with the transport about sending them out.
266 * @param n neighbour to check.
269 process_queue (struct Neighbour *n)
271 struct MessageEntry *m;
274 return; /* request already pending */
278 /* notify sessions that the queue is empty and more messages
279 could thus be queued now */
280 GSC_SESSIONS_solicit (&n->peer);
284 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
285 "Asking transport for transmission of %u bytes to `%4s' in next %llu ms\n",
286 (unsigned int) m->size, GNUNET_i2s (&n->peer),
288 GNUNET_TIME_absolute_get_remaining (m->deadline).rel_value);
291 GNUNET_TRANSPORT_notify_transmit_ready (transport, &n->peer, m->size,
293 GNUNET_TIME_absolute_get_remaining
299 /* message request too large or duplicate request */
301 /* discard encrypted message */
302 GNUNET_CONTAINER_DLL_remove (n->encrypted_head, n->encrypted_tail, m);
310 * Function called by transport to notify us that
311 * a peer connected to us (on the network level).
314 * @param peer the peer that connected
315 * @param ats performance data
316 * @param ats_count number of entries in ats (excluding 0-termination)
319 handle_transport_notify_connect (void *cls,
320 const struct GNUNET_PeerIdentity *peer,
321 const struct GNUNET_TRANSPORT_ATS_Information
322 *ats, uint32_t ats_count)
326 if (0 == memcmp (peer, &my_identity, sizeof (struct GNUNET_PeerIdentity)))
331 n = find_neighbour (peer);
334 /* duplicate connect notification!? */
339 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received connection from `%4s'.\n",
342 n = GNUNET_malloc (sizeof (struct Neighbour));
344 GNUNET_BANDWIDTH_tracker_init (&n->available_send_window,
345 GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT,
347 GNUNET_BANDWIDTH_tracker_init (&n->available_recv_window,
348 GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT,
350 GNUNET_assert (GNUNET_OK ==
351 GNUNET_CONTAINER_multihashmap_put (neighbours,
352 &n->peer.hashPubKey, n,
353 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
354 GNUNET_STATISTICS_set (stats, gettext_noop ("# neighbour entries allocated"),
355 GNUNET_CONTAINER_multihashmap_size (neighbours),
357 GNUNET_TRANSPORT_set_quota (transport, peer,
358 GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT,
359 GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT);
360 n->kx = GSC_KX_start (pid);
365 * Function called by transport telling us that a peer
369 * @param peer the peer that disconnected
372 handle_transport_notify_disconnect (void *cls,
373 const struct GNUNET_PeerIdentity *peer)
378 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
379 "Peer `%4s' disconnected from us; received notification from transport.\n",
382 n = find_neighbour (peer);
393 * Function called by the transport for each received message.
396 * @param peer (claimed) identity of the other peer
397 * @param message the message
398 * @param ats performance data
399 * @param ats_count number of entries in ats (excluding 0-termination)
402 handle_transport_receive (void *cls, const struct GNUNET_PeerIdentity *peer,
403 const struct GNUNET_MessageHeader *message,
404 const struct GNUNET_TRANSPORT_ATS_Information *ats,
411 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
412 "Received message of type %u from `%4s', demultiplexing.\n",
413 (unsigned int) ntohs (message->type), GNUNET_i2s (peer));
415 if (0 == memcmp (peer, &my_identity, sizeof (struct GNUNET_PeerIdentity)))
420 n = find_neighbour (peer);
423 /* received message from peer that is not connected!? */
427 type = ntohs (message->type);
430 case GNUNET_MESSAGE_TYPE_CORE_SET_KEY:
431 GSC_KX_handle_set_key (n->kxinfo, message);
433 case GNUNET_MESSAGE_TYPE_CORE_PING:
434 GSC_KX_handle_ping (n->kxinfo, message);
436 case GNUNET_MESSAGE_TYPE_CORE_PONG:
437 GSC_KX_handle_pong (n->kxinfo, message);
439 case GNUNET_MESSAGE_TYPE_CORE_ENCRYPTED_MESSAGE:
440 GSC_KX_handle_encrypted_message (peer,
446 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
447 _("Unsupported message of type %u received.\n"),
448 (unsigned int) type);
455 * Transmit the given message to the given target.
457 * @param target peer that should receive the message (must be connected)
458 * @param msg message to transmit
459 * @param timeout by when should the transmission be done?
462 GDS_NEIGHBOURS_transmit (const struct GNUNET_PeerIdentity *target,
463 const struct GNUNET_MessageHeader *msg,
464 struct GNUNET_TIME_Relative timeout)
466 struct MessageEntry *me;
470 n = find_neighbour (target);
476 msize = ntohs (msg->size);
477 me = GNUNET_malloc (sizeof (struct MessageEntry) + msize);
478 me->deadline = GNUNET_TIME_relative_to_absolute (timeout);
480 memcpy (&me[1], msg, msize);
481 GNUNET_CONTAINER_DLL_insert (n->message_head,
489 * Initialize neighbours subsystem.
492 GSC_NEIGHBOURS_init ()
494 neighbours = GNUNET_CONTAINER_multihashmap_create (128);
496 GNUNET_TRANSPORT_connect (GSC_cfg,
497 &GSC_my_identity, NULL,
498 &handle_transport_receive,
499 &handle_transport_notify_connect,
500 &handle_transport_notify_disconnect);
501 if (NULL == transport)
503 GNUNET_CONTAINER_multihashmap_destroy (neighbours);
505 return GNUNET_SYSERR;
512 * Wrapper around 'free_neighbour'.
515 * @param key peer identity
516 * @param value the 'struct Neighbour' to free
517 * @return GNUNET_OK (continue to iterate)
520 free_neighbour_helper (void *cls, const GNUNET_HashCode * key, void *value)
522 struct Neighbour *n = value;
530 * Shutdown neighbours subsystem.
533 GSC_NEIGHBOURS_done ()
535 if (NULL == transport)
537 GNUNET_CONTAINER_multihashmap_iterate (neighbours, &free_neighbour_helper,
539 GNUNET_TRANSPORT_disconnect (transport);
541 GNUNET_CONTAINER_multihashmap_destroy (neighbours);
545 /* end of gnunet-service-core_neighbours.c */