2 This file is part of GNUnet.
3 (C) 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 transport/gnunet-service-transport.c
24 * @author Christian Grothoff
27 #include "gnunet_util_lib.h"
28 #include "gnunet_hello_lib.h"
29 #include "gnunet_statistics_service.h"
30 #include "gnunet_transport_service.h"
31 #include "gnunet_peerinfo_service.h"
32 #include "gnunet_ats_service.h"
33 #include "gnunet-service-transport.h"
34 #include "gnunet-service-transport_blacklist.h"
35 #include "gnunet-service-transport_clients.h"
36 #include "gnunet-service-transport_hello.h"
37 #include "gnunet-service-transport_neighbours.h"
38 #include "gnunet-service-transport_plugins.h"
39 #include "gnunet-service-transport_validation.h"
40 #include "transport.h"
47 struct GNUNET_STATISTICS_Handle *GST_stats;
50 * Configuration handle.
52 const struct GNUNET_CONFIGURATION_Handle *GST_cfg;
55 * Configuration handle.
57 struct GNUNET_PeerIdentity GST_my_identity;
60 * Handle to peerinfo service.
62 struct GNUNET_PEERINFO_Handle *GST_peerinfo;
67 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded GST_my_public_key;
72 struct GNUNET_CRYPTO_RsaPrivateKey *GST_my_private_key;
77 struct GNUNET_ATS_SchedulingHandle *GST_ats;
80 * DEBUGGING connection counter
82 static int connections;
86 * Transmit our HELLO message to the given (connected) neighbour.
88 * @param cls the 'HELLO' message
89 * @param target a connected neighbour
90 * @param ats performance information (unused)
91 * @param ats_count number of records in ats (unused)
92 * @param address the address
95 transmit_our_hello (void *cls, const struct GNUNET_PeerIdentity *target,
96 const struct GNUNET_ATS_Information *ats,
98 const struct GNUNET_HELLO_Address *address)
100 const struct GNUNET_MessageHeader *hello = cls;
102 GST_neighbours_send (target, (const char *) hello, ntohs (hello->size),
103 GNUNET_CONSTANTS_HELLO_ADDRESS_EXPIRATION, NULL, NULL);
108 * My HELLO has changed. Tell everyone who should know.
111 * @param hello new HELLO
114 process_hello_update (void *cls, const struct GNUNET_MessageHeader *hello)
116 GST_clients_broadcast (hello, GNUNET_NO);
117 GST_neighbours_iterate (&transmit_our_hello, (void *) hello);
123 * We received some payload. Prepare to pass it on to our clients.
125 * @param peer (claimed) identity of the other peer
126 * @param address the address
127 * @param session session used
128 * @param message the message to process
129 * @param ats performance information
130 * @param ats_count number of records in ats
131 * @return how long the plugin should wait until receiving more data
133 static struct GNUNET_TIME_Relative
134 process_payload (const struct GNUNET_PeerIdentity *peer,
135 const struct GNUNET_HELLO_Address *address,
136 struct Session *session,
137 const struct GNUNET_MessageHeader *message,
138 const struct GNUNET_ATS_Information *ats, uint32_t ats_count)
140 struct GNUNET_TIME_Relative ret;
142 struct InboundMessage *im;
143 size_t msg_size = ntohs (message->size);
145 sizeof (struct InboundMessage) + msg_size +
146 sizeof (struct GNUNET_ATS_Information) * (ats_count + 1);
147 char buf[size] GNUNET_ALIGN;
148 struct GNUNET_ATS_Information *ap;
150 ret = GNUNET_TIME_UNIT_ZERO;
151 do_forward = GNUNET_SYSERR;
152 ret = GST_neighbours_calculate_receive_delay (peer, msg_size, &do_forward);
154 if (!GST_neighbours_test_connected (peer))
157 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
158 "Discarded %u bytes type %u payload from peer `%s'\n", msg_size,
159 ntohs (message->type), GNUNET_i2s (peer));
161 GNUNET_STATISTICS_update (GST_stats,
163 ("# bytes payload discarded due to not connected peer "),
164 msg_size, GNUNET_NO);
168 if (do_forward != GNUNET_YES)
170 im = (struct InboundMessage *) buf;
171 im->header.size = htons (size);
172 im->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_RECV);
173 im->ats_count = htonl (ats_count + 1);
175 ap = (struct GNUNET_ATS_Information *) &im[1];
176 memcpy (ap, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
177 ap[ats_count].type = htonl (GNUNET_ATS_QUALITY_NET_DELAY);
178 ap[ats_count].value =
179 htonl ((uint32_t) GST_neighbour_get_latency (peer).rel_value);
180 memcpy (&ap[ats_count + 1], message, ntohs (message->size));
182 GNUNET_ATS_address_update (GST_ats, address, session, ap, ats_count + 1);
183 GST_clients_broadcast (&im->header, GNUNET_YES);
190 * Function called by the transport for each received message.
191 * This function should also be called with "NULL" for the
192 * message to signal that the other peer disconnected.
194 * @param cls closure, const char* with the name of the plugin we received the message from
195 * @param peer (claimed) identity of the other peer
196 * @param message the message, NULL if we only care about
197 * learning about the delay until we should receive again -- FIXME!
198 * @param ats performance information
199 * @param ats_count number of records in ats
200 * @param session identifier used for this session (NULL for plugins
201 * that do not offer bi-directional communication to the sender
202 * using the same "connection")
203 * @param sender_address binary address of the sender (if we established the
204 * connection or are otherwise sure of it; should be NULL
205 * for inbound TCP/UDP connections since it it not clear
206 * that we could establish ourselves a connection to that
207 * IP address and get the same system)
208 * @param sender_address_len number of bytes in sender_address
209 * @return how long the plugin should wait until receiving more data
210 * (plugins that do not support this, can ignore the return value)
212 static struct GNUNET_TIME_Relative
213 plugin_env_receive_callback (void *cls, const struct GNUNET_PeerIdentity *peer,
214 const struct GNUNET_MessageHeader *message,
215 const struct GNUNET_ATS_Information *ats,
216 uint32_t ats_count, struct Session *session,
217 const char *sender_address,
218 uint16_t sender_address_len)
220 const char *plugin_name = cls;
221 struct GNUNET_TIME_Relative ret;
222 struct GNUNET_HELLO_Address address;
225 address.peer = *peer;
226 address.address = sender_address;
227 address.address_length = sender_address_len;
228 address.transport_name = plugin_name;
229 ret = GNUNET_TIME_UNIT_ZERO;
232 type = ntohs (message->type);
233 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Received Message with type %u from peer `%s'\n", type, GNUNET_i2s (peer));
235 GNUNET_STATISTICS_update (GST_stats,
237 ("# bytes total received"),
238 ntohs (message->size), GNUNET_NO);
242 case GNUNET_MESSAGE_TYPE_HELLO:
243 GST_validation_handle_hello (message);
245 case GNUNET_MESSAGE_TYPE_TRANSPORT_PING:
246 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
247 "Processing `%s' from `%s'\n", "PING",
249 NULL) ? GST_plugins_a2s (&address) : "<inbound>");
250 GST_validation_handle_ping (peer, message, &address, session);
252 case GNUNET_MESSAGE_TYPE_TRANSPORT_PONG:
253 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
254 "Processing `%s' from `%s'\n", "PONG",
256 NULL) ? GST_plugins_a2s (&address) : "<inbound>");
257 GST_validation_handle_pong (peer, message);
259 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT:
260 GST_neighbours_handle_connect (message, peer, &address, session, ats,
263 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT_ACK:
264 GST_neighbours_handle_connect_ack (message, peer, &address, session, ats,
267 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_ACK:
268 GST_neighbours_handle_session_ack (message, peer, &address, session, ats,
271 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT:
272 GST_neighbours_handle_disconnect_message (peer, message);
274 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE:
275 GST_neighbours_keepalive (peer);
277 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE_RESPONSE:
278 GST_neighbours_keepalive_response (peer, ats, ats_count);
281 /* should be payload */
282 GNUNET_STATISTICS_update (GST_stats,
284 ("# bytes payload received"),
285 ntohs (message->size), GNUNET_NO);
286 ret = process_payload (peer, &address, session, message, ats, ats_count);
291 /* FIXME: this should not be needed, and not sure it's good to have it, but without
292 * this connections seem to go extra-slow */
293 GNUNET_ATS_address_update (GST_ats, &address, session, ats, ats_count);
295 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
296 "Allowing receive from peer %s to continue in %llu ms\n",
297 GNUNET_i2s (peer), (unsigned long long) ret.rel_value);
303 * Function that will be called for each address the transport
304 * is aware that it might be reachable under. Update our HELLO.
306 * @param cls name of the plugin (const char*)
307 * @param add_remove should the address added (YES) or removed (NO) from the
308 * set of valid addresses?
309 * @param addr one of the addresses of the host
310 * the specific address format depends on the transport
311 * @param addrlen length of the address
314 plugin_env_address_change_notification (void *cls, int add_remove,
315 const void *addr, size_t addrlen)
317 const char *plugin_name = cls;
318 struct GNUNET_HELLO_Address address;
320 address.peer = GST_my_identity;
321 address.transport_name = plugin_name;
322 address.address = addr;
323 address.address_length = addrlen;
324 GST_hello_modify_addresses (add_remove, &address);
329 * Function that will be called whenever the plugin internally
330 * cleans up a session pointer and hence the service needs to
331 * discard all of those sessions as well. Plugins that do not
332 * use sessions can simply omit calling this function and always
333 * use NULL wherever a session pointer is needed. This function
334 * should be called BEFORE a potential "TransmitContinuation"
335 * from the "TransmitFunction".
338 * @param peer which peer was the session for
339 * @param session which session is being destoyed
342 plugin_env_session_end (void *cls, const struct GNUNET_PeerIdentity *peer,
343 struct Session *session)
345 const char *transport_name = cls;
346 struct GNUNET_HELLO_Address address;
348 GNUNET_assert (strlen (transport_name) > 0);
349 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Session %X to peer `%s' ended \n",
350 session, GNUNET_i2s (peer));
352 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
354 "Telling ATS to destroy session %p from peer %s\n",
355 session, GNUNET_i2s (peer));
356 address.peer = *peer;
357 address.address = NULL;
358 address.address_length = 0;
359 address.transport_name = transport_name;
360 GST_neighbours_session_terminated (peer, session);
361 GNUNET_ATS_address_destroyed (GST_ats, &address, session);
366 * Function that will be called to figure if an address is an loopback,
367 * LAN, WAN etc. address
370 * @param addr binary address
371 * @param addrlen length of the address
372 * @return ATS Information containing the network type
374 static const struct GNUNET_ATS_Information
375 plugin_env_address_to_type (void *cls,
376 const struct sockaddr *addr,
379 struct GNUNET_ATS_Information ats;
380 ats.type = htonl (GNUNET_ATS_NETWORK_TYPE);
381 ats.value = htonl (GNUNET_ATS_NET_UNSPECIFIED);
387 if (((addr->sa_family != AF_INET) && (addrlen != sizeof (struct sockaddr_in))) &&
388 ((addr->sa_family != AF_INET6) && (addrlen != sizeof (struct sockaddr_in6))) &&
389 (addr->sa_family != AF_UNIX))
391 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Malformed address with length %u `%s'\n",
393 GNUNET_a2s(addr, addrlen));
395 return (const struct GNUNET_ATS_Information) ats;
397 return GNUNET_ATS_address_get_type(GST_ats, addr, addrlen);
402 * Function called by ATS to notify the callee that the
403 * assigned bandwidth or address for a given peer was changed. If the
404 * callback is called with address/bandwidth assignments of zero, the
405 * ATS disconnect function will still be called once the disconnect
409 * @param address address to use (for peer given in address)
410 * @param session session to use (if available)
411 * @param bandwidth_out assigned outbound bandwidth for the connection, 0 to disconnect from peer
412 * @param bandwidth_in assigned inbound bandwidth for the connection, 0 to disconnect from peer
413 * @param ats ATS information
414 * @param ats_count number of ATS elements
417 ats_request_address_change (void *cls,
418 const struct GNUNET_HELLO_Address *address,
419 struct Session *session,
420 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
421 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
422 const struct GNUNET_ATS_Information *ats,
425 uint32_t bw_in = ntohl (bandwidth_in.value__);
426 uint32_t bw_out = ntohl (bandwidth_out.value__);
428 /* ATS tells me to disconnect from peer */
429 if ((bw_in == 0) && (bw_out == 0))
431 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
432 "ATS tells me to disconnect from peer `%s'\n",
433 GNUNET_i2s (&address->peer));
434 GST_neighbours_force_disconnect (&address->peer);
437 GST_neighbours_switch_to_address (&address->peer, address, session, ats,
438 ats_count, bandwidth_in,
444 * Function called to notify transport users that another
445 * peer connected to us.
448 * @param peer the peer that connected
449 * @param ats performance data
450 * @param ats_count number of entries in ats
453 neighbours_connect_notification (void *cls,
454 const struct GNUNET_PeerIdentity *peer,
455 const struct GNUNET_ATS_Information *ats,
459 sizeof (struct ConnectInfoMessage) +
460 ats_count * sizeof (struct GNUNET_ATS_Information);
461 char buf[len] GNUNET_ALIGN;
462 struct ConnectInfoMessage *connect_msg = (struct ConnectInfoMessage *) buf;
463 struct GNUNET_ATS_Information *ap;
466 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
467 "We are now connected to peer `%s' and %u peers in total\n",
468 GNUNET_i2s (peer), connections);
470 connect_msg->header.size = htons (sizeof (buf));
471 connect_msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
472 connect_msg->ats_count = htonl (ats_count);
473 connect_msg->id = *peer;
474 ap = (struct GNUNET_ATS_Information *) &connect_msg[1];
475 memcpy (ap, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
476 GST_clients_broadcast (&connect_msg->header, GNUNET_NO);
481 * Function called to notify transport users that another
482 * peer disconnected from us.
485 * @param peer the peer that disconnected
488 neighbours_disconnect_notification (void *cls,
489 const struct GNUNET_PeerIdentity *peer)
491 struct DisconnectInfoMessage disconnect_msg;
494 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
495 "Peer `%s' disconnected and we are connected to %u peers\n",
496 GNUNET_i2s (peer), connections);
498 disconnect_msg.header.size = htons (sizeof (struct DisconnectInfoMessage));
499 disconnect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT);
500 disconnect_msg.reserved = htonl (0);
501 disconnect_msg.peer = *peer;
502 GST_clients_broadcast (&disconnect_msg.header, GNUNET_NO);
507 * Function called to notify transport users that a neighbour peer changed its
511 * @param peer peer this update is about (never NULL)
512 * @param address address, NULL on disconnect
515 neighbours_address_notification (void *cls,
516 const struct GNUNET_PeerIdentity *peer,
517 const struct GNUNET_HELLO_Address *address)
519 GST_clients_broadcast_address_notification (peer, address);
524 * Function called when the service shuts down. Unloads our plugins
525 * and cancels pending validations.
527 * @param cls closure, unused
528 * @param tc task context (unused)
531 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
533 GST_neighbours_stop ();
534 GST_validation_stop ();
535 GST_plugins_unload ();
537 GNUNET_ATS_scheduling_done (GST_ats);
540 GST_blacklist_stop ();
543 if (GST_peerinfo != NULL)
545 GNUNET_PEERINFO_disconnect (GST_peerinfo);
548 if (GST_stats != NULL)
550 GNUNET_STATISTICS_destroy (GST_stats, GNUNET_NO);
553 if (GST_my_private_key != NULL)
555 GNUNET_CRYPTO_rsa_key_free (GST_my_private_key);
556 GST_my_private_key = NULL;
562 * Initiate transport service.
565 * @param server the initialized server
566 * @param c configuration to use
569 run (void *cls, struct GNUNET_SERVER_Handle *server,
570 const struct GNUNET_CONFIGURATION_Handle *c)
573 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded tmp;
577 GNUNET_CONFIGURATION_get_value_filename (c, "GNUNETD", "HOSTKEY",
580 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
582 ("Transport service is lacking key configuration settings. Exiting.\n"));
583 GNUNET_SCHEDULER_shutdown ();
586 GST_my_private_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
587 GNUNET_free (keyfile);
588 if (GST_my_private_key == NULL)
590 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
591 _("Transport service could not access hostkey. Exiting.\n"));
592 GNUNET_SCHEDULER_shutdown ();
595 GST_stats = GNUNET_STATISTICS_create ("transport", c);
596 GST_peerinfo = GNUNET_PEERINFO_connect (c);
597 memset (&GST_my_public_key, '\0', sizeof (GST_my_public_key));
598 memset (&tmp, '\0', sizeof (tmp));
599 GNUNET_CRYPTO_rsa_key_get_public (GST_my_private_key, &GST_my_public_key);
600 GNUNET_CRYPTO_hash (&GST_my_public_key, sizeof (GST_my_public_key),
601 &GST_my_identity.hashPubKey);
603 GNUNET_assert (NULL != GST_my_private_key);
604 GNUNET_assert (0 != memcmp (&GST_my_public_key, &tmp, sizeof (GST_my_public_key)));
606 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
608 if (GST_peerinfo == NULL)
610 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
611 _("Could not access PEERINFO service. Exiting.\n"));
612 GNUNET_SCHEDULER_shutdown ();
616 /* start subsystems */
617 GST_hello_start (&process_hello_update, NULL);
618 GNUNET_assert (NULL != GST_hello_get());
619 GST_blacklist_start (server);
621 GNUNET_ATS_scheduling_init (GST_cfg, &ats_request_address_change, NULL);
622 GST_plugins_load (&plugin_env_receive_callback,
623 &plugin_env_address_change_notification,
624 &plugin_env_session_end,
625 &plugin_env_address_to_type);
626 GST_neighbours_start (NULL,
627 &neighbours_connect_notification,
628 &neighbours_disconnect_notification,
629 &neighbours_address_notification);
630 GST_clients_start (server);
631 GST_validation_start ();
636 * The main function for the transport service.
638 * @param argc number of arguments from the command line
639 * @param argv command line arguments
640 * @return 0 ok, 1 on error
643 main (int argc, char *const *argv)
646 GNUNET_SERVICE_run (argc, argv, "transport",
647 GNUNET_SERVICE_OPTION_NONE, &run, NULL)) ? 0 : 1;
650 /* end of file gnunet-service-transport.c */