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_statistics_service.h"
29 #include "gnunet_transport_service.h"
30 #include "gnunet-service-core.h"
31 #include "gnunet-service-core_neighbours.h"
32 #include "gnunet-service-core_kx.h"
33 #include "gnunet-service-core_sessions.h"
34 #include "gnunet_constants.h"
38 * Receive and send buffer windows grow over time. For
39 * how long can 'unused' bandwidth accumulate before we
40 * need to cap it? (specified in seconds).
42 #define MAX_WINDOW_TIME_S (5 * 60)
46 * Message ready for transmission via transport service. This struct
47 * is followed by the actual content of the message.
53 * We keep messages in a doubly linked list.
55 struct MessageEntry *next;
58 * We keep messages in a doubly linked list.
60 struct MessageEntry *prev;
63 * By when are we supposed to transmit this message?
65 struct GNUNET_TIME_Absolute deadline;
68 * How long is the message? (number of bytes following the "struct
69 * MessageEntry", but not including the size of "struct
70 * MessageEntry" itself!)
78 * Data kept per transport-connected peer.
84 * Head of the batched message queue (already ordered, transmit
85 * starting with the head).
87 struct MessageEntry *message_head;
90 * Tail of the batched message queue (already ordered, append new
93 struct MessageEntry *message_tail;
96 * Handle for pending requests for transmission to this peer
97 * with the transport service. NULL if no request is pending.
99 struct GNUNET_TRANSPORT_TransmitHandle *th;
102 * Information about the key exchange with the other peer.
104 struct GSC_KeyExchangeInfo *kxinfo;
107 * Identity of the other peer.
109 struct GNUNET_PeerIdentity peer;
112 * ID of task used for re-trying plaintext scheduling.
114 GNUNET_SCHEDULER_TaskIdentifier retry_plaintext_task;
117 * Tracking bandwidth for sending to this peer.
119 struct GNUNET_BANDWIDTH_Tracker available_send_window;
122 * Tracking bandwidth for sending to this peer.
124 struct GNUNET_BANDWIDTH_Tracker available_recv_window;
130 * Map of peer identities to 'struct Neighbour'.
132 static struct GNUNET_CONTAINER_MultiHashMap *neighbours;
137 static struct GNUNET_TRANSPORT_Handle *transport;
141 * Find the entry for the given neighbour.
143 * @param peer identity of the neighbour
144 * @return NULL if we are not connected, otherwise the
147 static struct Neighbour *
148 find_neighbour (const struct GNUNET_PeerIdentity *peer)
150 return GNUNET_CONTAINER_multihashmap_get (neighbours, &peer->hashPubKey);
155 * Free the given entry for the neighbour.
157 * @param n neighbour to free
160 free_neighbour (struct Neighbour *n)
162 struct MessageEntry *m;
165 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
166 "Destroying neighbour entry for peer `%4s'\n",
167 GNUNET_i2s (&n->peer));
169 while (NULL != (m = n->message_head))
171 GNUNET_CONTAINER_DLL_remove (n->message_head, n->message_tail, m);
176 GNUNET_TRANSPORT_notify_transmit_ready_cancel (n->th);
179 GSC_SESSIONS_end (&n->peer);
180 if (NULL != n->kxinfo)
182 GSC_KX_stop (n->kxinfo);
185 if (n->retry_plaintext_task != GNUNET_SCHEDULER_NO_TASK)
187 GNUNET_SCHEDULER_cancel (n->retry_plaintext_task);
188 n->retry_plaintext_task = GNUNET_SCHEDULER_NO_TASK;
190 GNUNET_assert (GNUNET_OK ==
191 GNUNET_CONTAINER_multihashmap_remove (neighbours,
192 &n->peer.hashPubKey, n));
193 GNUNET_STATISTICS_set (GSC_stats, gettext_noop ("# neighbour entries allocated"),
194 GNUNET_CONTAINER_multihashmap_size (neighbours),
201 * Check if we have encrypted messages for the specified neighbour
202 * pending, and if so, check with the transport about sending them
205 * @param n neighbour to check.
208 process_queue (struct Neighbour *n);
212 * Function called when the transport service is ready to receive a
213 * message for the respective peer
215 * @param cls neighbour to use message from
216 * @param size number of bytes we can transmit
217 * @param buf where to copy the message
218 * @return number of bytes transmitted
221 transmit_ready (void *cls, size_t size, void *buf)
223 struct Neighbour *n = cls;
224 struct MessageEntry *m;
235 GNUNET_CONTAINER_DLL_remove (n->message_head, n->message_tail, m);
239 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
240 "Transmission of message of type %u and size %u failed\n",
242 ntohs (((struct GNUNET_MessageHeader *) &m[1])->type),
243 (unsigned int) m->size);
251 GNUNET_assert (size >= m->size);
252 memcpy (cbuf, &m[1], m->size);
254 GNUNET_BANDWIDTH_tracker_consume (&n->available_send_window, m->size);
256 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
257 "Copied message of type %u and size %u into transport buffer for `%4s'\n",
259 ntohs (((struct GNUNET_MessageHeader *) &m[1])->type),
260 (unsigned int) ret, GNUNET_i2s (&n->peer));
264 GNUNET_STATISTICS_update (GSC_stats,
266 ("# encrypted bytes given to transport"), ret,
273 * Check if we have messages for the specified neighbour pending, and
274 * if so, check with the transport about sending them out.
276 * @param n neighbour to check.
279 process_queue (struct Neighbour *n)
281 struct MessageEntry *m;
284 return; /* request already pending */
288 /* notify sessions that the queue is empty and more messages
289 could thus be queued now */
290 GSC_SESSIONS_solicit (&n->peer);
294 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
295 "Asking transport for transmission of %u bytes to `%4s' in next %llu ms\n",
296 (unsigned int) m->size, GNUNET_i2s (&n->peer),
298 GNUNET_TIME_absolute_get_remaining (m->deadline).rel_value);
301 GNUNET_TRANSPORT_notify_transmit_ready (transport, &n->peer, m->size,
303 GNUNET_TIME_absolute_get_remaining
309 /* message request too large or duplicate request */
311 /* discard encrypted message */
312 GNUNET_CONTAINER_DLL_remove (n->message_head, n->message_tail, m);
320 * Function called by transport to notify us that
321 * a peer connected to us (on the network level).
324 * @param peer the peer that connected
325 * @param ats performance data
326 * @param ats_count number of entries in ats (excluding 0-termination)
329 handle_transport_notify_connect (void *cls,
330 const struct GNUNET_PeerIdentity *peer,
331 const struct GNUNET_TRANSPORT_ATS_Information
332 *ats, uint32_t ats_count)
336 if (0 == memcmp (peer, &GSC_my_identity, sizeof (struct GNUNET_PeerIdentity)))
341 n = find_neighbour (peer);
344 /* duplicate connect notification!? */
349 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received connection from `%4s'.\n",
352 n = GNUNET_malloc (sizeof (struct Neighbour));
354 GNUNET_BANDWIDTH_tracker_init (&n->available_send_window,
355 GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT,
357 GNUNET_BANDWIDTH_tracker_init (&n->available_recv_window,
358 GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT,
360 GNUNET_assert (GNUNET_OK ==
361 GNUNET_CONTAINER_multihashmap_put (neighbours,
362 &n->peer.hashPubKey, n,
363 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
364 GNUNET_STATISTICS_set (GSC_stats, gettext_noop ("# neighbour entries allocated"),
365 GNUNET_CONTAINER_multihashmap_size (neighbours),
367 GNUNET_TRANSPORT_set_quota (transport, peer,
368 GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT,
369 GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT);
370 n->kxinfo = GSC_KX_start (peer);
375 * Function called by transport telling us that a peer
379 * @param peer the peer that disconnected
382 handle_transport_notify_disconnect (void *cls,
383 const struct GNUNET_PeerIdentity *peer)
388 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
389 "Peer `%4s' disconnected from us; received notification from transport.\n",
392 n = find_neighbour (peer);
403 * Function called by the transport for each received message.
406 * @param peer (claimed) identity of the other peer
407 * @param message the message
408 * @param ats performance data
409 * @param ats_count number of entries in ats (excluding 0-termination)
412 handle_transport_receive (void *cls, const struct GNUNET_PeerIdentity *peer,
413 const struct GNUNET_MessageHeader *message,
414 const struct GNUNET_TRANSPORT_ATS_Information *ats,
421 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
422 "Received message of type %u from `%4s', demultiplexing.\n",
423 (unsigned int) ntohs (message->type), GNUNET_i2s (peer));
425 if (0 == memcmp (peer, &GSC_my_identity, sizeof (struct GNUNET_PeerIdentity)))
430 n = find_neighbour (peer);
433 /* received message from peer that is not connected!? */
437 type = ntohs (message->type);
440 case GNUNET_MESSAGE_TYPE_CORE_SET_KEY:
441 GSC_KX_handle_set_key (n->kxinfo, message);
443 case GNUNET_MESSAGE_TYPE_CORE_PING:
444 GSC_KX_handle_ping (n->kxinfo, message);
446 case GNUNET_MESSAGE_TYPE_CORE_PONG:
447 GSC_KX_handle_pong (n->kxinfo, message);
449 case GNUNET_MESSAGE_TYPE_CORE_ENCRYPTED_MESSAGE:
450 GSC_KX_handle_encrypted_message (n->kxinfo,
455 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
456 _("Unsupported message of type %u received.\n"),
457 (unsigned int) type);
464 * Transmit the given message to the given target.
466 * @param target peer that should receive the message (must be connected)
467 * @param msg message to transmit
468 * @param timeout by when should the transmission be done?
471 GDS_NEIGHBOURS_transmit (const struct GNUNET_PeerIdentity *target,
472 const struct GNUNET_MessageHeader *msg,
473 struct GNUNET_TIME_Relative timeout)
475 struct MessageEntry *me;
479 n = find_neighbour (target);
485 msize = ntohs (msg->size);
486 me = GNUNET_malloc (sizeof (struct MessageEntry) + msize);
487 me->deadline = GNUNET_TIME_relative_to_absolute (timeout);
489 memcpy (&me[1], msg, msize);
490 GNUNET_CONTAINER_DLL_insert (n->message_head,
498 * Initialize neighbours subsystem.
501 GSC_NEIGHBOURS_init ()
503 neighbours = GNUNET_CONTAINER_multihashmap_create (128);
505 GNUNET_TRANSPORT_connect (GSC_cfg,
506 &GSC_my_identity, NULL,
507 &handle_transport_receive,
508 &handle_transport_notify_connect,
509 &handle_transport_notify_disconnect);
510 if (NULL == transport)
512 GNUNET_CONTAINER_multihashmap_destroy (neighbours);
514 return GNUNET_SYSERR;
521 * Wrapper around 'free_neighbour'.
524 * @param key peer identity
525 * @param value the 'struct Neighbour' to free
526 * @return GNUNET_OK (continue to iterate)
529 free_neighbour_helper (void *cls, const GNUNET_HashCode * key, void *value)
531 struct Neighbour *n = value;
539 * Shutdown neighbours subsystem.
542 GSC_NEIGHBOURS_done ()
544 if (NULL == transport)
546 GNUNET_CONTAINER_multihashmap_iterate (neighbours, &free_neighbour_helper,
548 GNUNET_TRANSPORT_disconnect (transport);
550 GNUNET_CONTAINER_multihashmap_destroy (neighbours);
554 /* end of gnunet-service-core_neighbours.c */