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.
49 struct NeighbourMessageEntry
53 * We keep messages in a doubly linked list.
55 struct NeighbourMessageEntry *next;
58 * We keep messages in a doubly linked list.
60 struct NeighbourMessageEntry *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 NeighbourMessageEntry *message_head;
90 * Tail of the batched message queue (already ordered, append new
93 struct NeighbourMessageEntry *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_recv_window;
125 * Map of peer identities to 'struct Neighbour'.
127 static struct GNUNET_CONTAINER_MultiHashMap *neighbours;
132 static struct GNUNET_TRANSPORT_Handle *transport;
136 * Find the entry for the given neighbour.
138 * @param peer identity of the neighbour
139 * @return NULL if we are not connected, otherwise the
142 static struct Neighbour *
143 find_neighbour (const struct GNUNET_PeerIdentity *peer)
145 return GNUNET_CONTAINER_multihashmap_get (neighbours, &peer->hashPubKey);
150 * Free the given entry for the neighbour.
152 * @param n neighbour to free
155 free_neighbour (struct Neighbour *n)
157 struct NeighbourMessageEntry *m;
160 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
161 "Destroying neighbour entry for peer `%4s'\n",
162 GNUNET_i2s (&n->peer));
164 while (NULL != (m = n->message_head))
166 GNUNET_CONTAINER_DLL_remove (n->message_head, n->message_tail, m);
171 GNUNET_TRANSPORT_notify_transmit_ready_cancel (n->th);
174 GSC_SESSIONS_end (&n->peer);
175 if (NULL != n->kxinfo)
177 GSC_KX_stop (n->kxinfo);
180 if (n->retry_plaintext_task != GNUNET_SCHEDULER_NO_TASK)
182 GNUNET_SCHEDULER_cancel (n->retry_plaintext_task);
183 n->retry_plaintext_task = GNUNET_SCHEDULER_NO_TASK;
185 GNUNET_assert (GNUNET_OK ==
186 GNUNET_CONTAINER_multihashmap_remove (neighbours,
187 &n->peer.hashPubKey, n));
188 GNUNET_STATISTICS_set (GSC_stats, gettext_noop ("# neighbour entries allocated"),
189 GNUNET_CONTAINER_multihashmap_size (neighbours),
196 * Check if we have encrypted messages for the specified neighbour
197 * pending, and if so, check with the transport about sending them
200 * @param n neighbour to check.
203 process_queue (struct Neighbour *n);
207 * Function called when the transport service is ready to receive a
208 * message for the respective peer
210 * @param cls neighbour to use message from
211 * @param size number of bytes we can transmit
212 * @param buf where to copy the message
213 * @return number of bytes transmitted
216 transmit_ready (void *cls, size_t size, void *buf)
218 struct Neighbour *n = cls;
219 struct NeighbourMessageEntry *m;
230 GNUNET_CONTAINER_DLL_remove (n->message_head, n->message_tail, m);
234 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
235 "Transmission of message of type %u and size %u failed\n",
237 ntohs (((struct GNUNET_MessageHeader *) &m[1])->type),
238 (unsigned int) m->size);
246 GNUNET_assert (size >= m->size);
247 memcpy (cbuf, &m[1], m->size);
250 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
251 "Copied message of type %u and size %u into transport buffer for `%4s'\n",
253 ntohs (((struct GNUNET_MessageHeader *) &m[1])->type),
254 (unsigned int) ret, GNUNET_i2s (&n->peer));
258 GNUNET_STATISTICS_update (GSC_stats,
260 ("# encrypted bytes given to transport"), ret,
267 * Check if we have messages for the specified neighbour pending, and
268 * if so, check with the transport about sending them out.
270 * @param n neighbour to check.
273 process_queue (struct Neighbour *n)
275 struct NeighbourMessageEntry *m;
278 return; /* request already pending */
282 /* notify sessions that the queue is empty and more messages
283 could thus be queued now */
284 GSC_SESSIONS_solicit (&n->peer);
288 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
289 "Asking transport for transmission of %u bytes to `%4s' in next %llu ms\n",
290 (unsigned int) m->size, GNUNET_i2s (&n->peer),
292 GNUNET_TIME_absolute_get_remaining (m->deadline).rel_value);
295 GNUNET_TRANSPORT_notify_transmit_ready (transport, &n->peer, m->size,
297 GNUNET_TIME_absolute_get_remaining
303 /* message request too large or duplicate request */
305 /* discard encrypted message */
306 GNUNET_CONTAINER_DLL_remove (n->message_head, n->message_tail, m);
314 * Function called by transport to notify us that
315 * a peer connected to us (on the network level).
318 * @param peer the peer that connected
319 * @param ats performance data
320 * @param ats_count number of entries in ats (excluding 0-termination)
323 handle_transport_notify_connect (void *cls,
324 const struct GNUNET_PeerIdentity *peer,
325 const struct GNUNET_TRANSPORT_ATS_Information
326 *ats, uint32_t ats_count)
330 if (0 == memcmp (peer, &GSC_my_identity, sizeof (struct GNUNET_PeerIdentity)))
335 n = find_neighbour (peer);
338 /* duplicate connect notification!? */
343 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received connection from `%4s'.\n",
346 n = GNUNET_malloc (sizeof (struct Neighbour));
348 GNUNET_BANDWIDTH_tracker_init (&n->available_recv_window,
349 GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT,
351 GNUNET_assert (GNUNET_OK ==
352 GNUNET_CONTAINER_multihashmap_put (neighbours,
353 &n->peer.hashPubKey, n,
354 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
355 GNUNET_STATISTICS_set (GSC_stats, gettext_noop ("# neighbour entries allocated"),
356 GNUNET_CONTAINER_multihashmap_size (neighbours),
358 GNUNET_TRANSPORT_set_quota (transport, peer,
359 GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT,
360 GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT);
361 n->kxinfo = GSC_KX_start (peer);
366 * Function called by transport telling us that a peer
370 * @param peer the peer that disconnected
373 handle_transport_notify_disconnect (void *cls,
374 const struct GNUNET_PeerIdentity *peer)
379 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
380 "Peer `%4s' disconnected from us; received notification from transport.\n",
383 n = find_neighbour (peer);
394 * Function called by the transport for each received message.
397 * @param peer (claimed) identity of the other peer
398 * @param message the message
399 * @param ats performance data
400 * @param ats_count number of entries in ats (excluding 0-termination)
403 handle_transport_receive (void *cls, const struct GNUNET_PeerIdentity *peer,
404 const struct GNUNET_MessageHeader *message,
405 const struct GNUNET_TRANSPORT_ATS_Information *ats,
412 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
413 "Received message of type %u from `%4s', demultiplexing.\n",
414 (unsigned int) ntohs (message->type), GNUNET_i2s (peer));
416 if (0 == memcmp (peer, &GSC_my_identity, sizeof (struct GNUNET_PeerIdentity)))
421 n = find_neighbour (peer);
424 /* received message from peer that is not connected!? */
428 type = ntohs (message->type);
431 case GNUNET_MESSAGE_TYPE_CORE_SET_KEY:
432 GSC_KX_handle_set_key (n->kxinfo, message);
434 case GNUNET_MESSAGE_TYPE_CORE_PING:
435 GSC_KX_handle_ping (n->kxinfo, message);
437 case GNUNET_MESSAGE_TYPE_CORE_PONG:
438 GSC_KX_handle_pong (n->kxinfo, message);
440 case GNUNET_MESSAGE_TYPE_CORE_ENCRYPTED_MESSAGE:
441 GSC_KX_handle_encrypted_message (n->kxinfo,
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 GSC_NEIGHBOURS_transmit (const struct GNUNET_PeerIdentity *target,
463 const struct GNUNET_MessageHeader *msg,
464 struct GNUNET_TIME_Relative timeout)
466 struct NeighbourMessageEntry *me;
470 n = find_neighbour (target);
476 msize = ntohs (msg->size);
477 me = GNUNET_malloc (sizeof (struct NeighbourMessageEntry) + 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 */