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;
65 * Hostkey generation context
67 struct GNUNET_CRYPTO_RsaKeyGenerationContext *GST_keygen;
70 * Handle to our service's server.
72 static struct GNUNET_SERVER_Handle *GST_server;
77 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded GST_my_public_key;
82 struct GNUNET_CRYPTO_RsaPrivateKey *GST_my_private_key;
87 struct GNUNET_ATS_SchedulingHandle *GST_ats;
90 * DEBUGGING connection counter
92 static int connections;
95 * Hello address expiration
97 struct GNUNET_TIME_Relative hello_expiration;
101 * Transmit our HELLO message to the given (connected) neighbour.
103 * @param cls the 'HELLO' message
104 * @param target a connected neighbour
105 * @param ats performance information (unused)
106 * @param ats_count number of records in ats (unused)
107 * @param address the address
108 * @param bandwidth_in inbound quota in NBO
109 * @param bandwidth_out outbound quota in NBO
112 transmit_our_hello (void *cls, const struct GNUNET_PeerIdentity *target,
113 const struct GNUNET_ATS_Information *ats,
115 const struct GNUNET_HELLO_Address *address,
116 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
117 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out)
119 const struct GNUNET_MessageHeader *hello = cls;
121 GST_neighbours_send (target, (const char *) hello, ntohs (hello->size),
122 hello_expiration, NULL, NULL);
127 * My HELLO has changed. Tell everyone who should know.
130 * @param hello new HELLO
133 process_hello_update (void *cls, const struct GNUNET_MessageHeader *hello)
135 GST_clients_broadcast (hello, GNUNET_NO);
136 GST_neighbours_iterate (&transmit_our_hello, (void *) hello);
142 * We received some payload. Prepare to pass it on to our clients.
144 * @param peer (claimed) identity of the other peer
145 * @param address the address
146 * @param session session used
147 * @param message the message to process
148 * @param ats performance information
149 * @param ats_count number of records in ats
150 * @return how long the plugin should wait until receiving more data
152 static struct GNUNET_TIME_Relative
153 process_payload (const struct GNUNET_PeerIdentity *peer,
154 const struct GNUNET_HELLO_Address *address,
155 struct Session *session,
156 const struct GNUNET_MessageHeader *message,
157 const struct GNUNET_ATS_Information *ats, uint32_t ats_count)
159 struct GNUNET_TIME_Relative ret;
161 struct InboundMessage *im;
162 size_t msg_size = ntohs (message->size);
164 sizeof (struct InboundMessage) + msg_size +
165 sizeof (struct GNUNET_ATS_Information) * (ats_count + 1);
166 char buf[size] GNUNET_ALIGN;
167 struct GNUNET_ATS_Information *ap;
169 ret = GNUNET_TIME_UNIT_ZERO;
170 do_forward = GNUNET_SYSERR;
171 ret = GST_neighbours_calculate_receive_delay (peer, msg_size, &do_forward);
173 if (!GST_neighbours_test_connected (peer))
176 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
177 "Discarded %u bytes type %u payload from peer `%s'\n", msg_size,
178 ntohs (message->type), GNUNET_i2s (peer));
180 GNUNET_STATISTICS_update (GST_stats,
182 ("# bytes payload discarded due to not connected peer "),
183 msg_size, GNUNET_NO);
187 if (do_forward != GNUNET_YES)
189 im = (struct InboundMessage *) buf;
190 im->header.size = htons (size);
191 im->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_RECV);
192 im->ats_count = htonl (ats_count + 1);
194 ap = (struct GNUNET_ATS_Information *) &im[1];
195 memcpy (ap, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
196 ap[ats_count].type = htonl (GNUNET_ATS_QUALITY_NET_DELAY);
197 ap[ats_count].value =
198 htonl ((uint32_t) GST_neighbour_get_latency (peer).rel_value);
199 memcpy (&ap[ats_count + 1], message, ntohs (message->size));
201 GNUNET_ATS_address_add (GST_ats, address, session, ap, ats_count + 1);
202 GNUNET_ATS_address_update (GST_ats, address, session, ap, ats_count + 1);
203 GST_clients_broadcast (&im->header, GNUNET_YES);
210 * Function called by the transport for each received message.
211 * This function should also be called with "NULL" for the
212 * message to signal that the other peer disconnected.
214 * @param cls closure, const char* with the name of the plugin we received the message from
215 * @param peer (claimed) identity of the other peer
216 * @param message the message, NULL if we only care about
217 * learning about the delay until we should receive again -- FIXME!
218 * @param ats performance information
219 * @param ats_count number of records in ats
220 * @param session identifier used for this session (NULL for plugins
221 * that do not offer bi-directional communication to the sender
222 * using the same "connection")
223 * @param sender_address binary address of the sender (if we established the
224 * connection or are otherwise sure of it; should be NULL
225 * for inbound TCP/UDP connections since it it not clear
226 * that we could establish ourselves a connection to that
227 * IP address and get the same system)
228 * @param sender_address_len number of bytes in sender_address
229 * @return how long the plugin should wait until receiving more data
230 * (plugins that do not support this, can ignore the return value)
232 static struct GNUNET_TIME_Relative
233 plugin_env_receive_callback (void *cls, const struct GNUNET_PeerIdentity *peer,
234 const struct GNUNET_MessageHeader *message,
235 const struct GNUNET_ATS_Information *ats,
236 uint32_t ats_count, struct Session *session,
237 const char *sender_address,
238 uint16_t sender_address_len)
240 const char *plugin_name = cls;
241 struct GNUNET_TIME_Relative ret;
242 struct GNUNET_HELLO_Address address;
245 address.peer = *peer;
246 address.address = sender_address;
247 address.address_length = sender_address_len;
248 address.transport_name = plugin_name;
249 ret = GNUNET_TIME_UNIT_ZERO;
252 type = ntohs (message->type);
253 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received Message with type %u from peer `%s'\n", type, GNUNET_i2s (peer));
255 GNUNET_STATISTICS_update (GST_stats,
257 ("# bytes total received"),
258 ntohs (message->size), GNUNET_NO);
262 case GNUNET_MESSAGE_TYPE_HELLO:
263 GST_validation_handle_hello (message);
265 case GNUNET_MESSAGE_TYPE_TRANSPORT_PING:
266 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
267 "Processing `%s' from `%s'\n", "PING",
269 NULL) ? GST_plugins_a2s (&address) : "<inbound>");
270 GST_validation_handle_ping (peer, message, &address, session);
272 case GNUNET_MESSAGE_TYPE_TRANSPORT_PONG:
273 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
274 "Processing `%s' from `%s'\n", "PONG",
276 NULL) ? GST_plugins_a2s (&address) : "<inbound>");
277 GST_validation_handle_pong (peer, message);
279 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT:
280 GST_neighbours_handle_connect (message, peer, &address, session, ats,
283 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT_ACK:
284 GST_neighbours_handle_connect_ack (message, peer, &address, session, ats,
287 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_ACK:
288 GST_neighbours_handle_session_ack (message, peer, &address, session, ats,
291 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT:
292 GST_neighbours_handle_disconnect_message (peer, message);
294 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE:
295 GST_neighbours_keepalive (peer);
297 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE_RESPONSE:
298 GST_neighbours_keepalive_response (peer, ats, ats_count);
301 /* should be payload */
302 GNUNET_STATISTICS_update (GST_stats,
304 ("# bytes payload received"),
305 ntohs (message->size), GNUNET_NO);
306 ret = process_payload (peer, &address, session, message, ats, ats_count);
310 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
311 "Allowing receive from peer %s to continue in %llu ms\n",
312 GNUNET_i2s (peer), (unsigned long long) ret.rel_value);
318 * Function that will be called for each address the transport
319 * is aware that it might be reachable under. Update our HELLO.
321 * @param cls name of the plugin (const char*)
322 * @param add_remove should the address added (YES) or removed (NO) from the
323 * set of valid addresses?
324 * @param addr one of the addresses of the host
325 * the specific address format depends on the transport
326 * @param addrlen length of the address
327 * @param dest_plugin destination plugin to use this address with
330 plugin_env_address_change_notification (void *cls, int add_remove,
331 const void *addr, size_t addrlen,
332 const char *dest_plugin)
334 struct GNUNET_HELLO_Address address;
336 address.peer = GST_my_identity;
337 address.transport_name = dest_plugin;
338 address.address = addr;
339 address.address_length = addrlen;
340 GST_hello_modify_addresses (add_remove, &address);
345 * Function that will be called whenever the plugin internally
346 * cleans up a session pointer and hence the service needs to
347 * discard all of those sessions as well. Plugins that do not
348 * use sessions can simply omit calling this function and always
349 * use NULL wherever a session pointer is needed. This function
350 * should be called BEFORE a potential "TransmitContinuation"
351 * from the "TransmitFunction".
354 * @param peer which peer was the session for
355 * @param session which session is being destoyed
358 plugin_env_session_end (void *cls, const struct GNUNET_PeerIdentity *peer,
359 struct Session *session)
361 const char *transport_name = cls;
362 struct GNUNET_HELLO_Address address;
364 GNUNET_assert (strlen (transport_name) > 0);
365 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Session %p to peer `%s' ended \n",
366 session, GNUNET_i2s (peer));
368 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
370 "Telling ATS to destroy session %p from peer %s\n",
371 session, GNUNET_i2s (peer));
372 address.peer = *peer;
373 address.address = NULL;
374 address.address_length = 0;
375 address.transport_name = transport_name;
376 GST_neighbours_session_terminated (peer, session);
378 /* Tell ATS that session has ended */
379 GNUNET_ATS_address_destroyed (GST_ats, &address, session);
384 * Function that will be called to figure if an address is an loopback,
385 * LAN, WAN etc. address
388 * @param addr binary address
389 * @param addrlen length of the address
390 * @return ATS Information containing the network type
392 static struct GNUNET_ATS_Information
393 plugin_env_address_to_type (void *cls,
394 const struct sockaddr *addr,
397 struct GNUNET_ATS_Information ats;
398 ats.type = htonl (GNUNET_ATS_NETWORK_TYPE);
399 ats.value = htonl (GNUNET_ATS_NET_UNSPECIFIED);
405 if (((addr->sa_family != AF_INET) && (addrlen != sizeof (struct sockaddr_in))) &&
406 ((addr->sa_family != AF_INET6) && (addrlen != sizeof (struct sockaddr_in6))) &&
407 (addr->sa_family != AF_UNIX))
409 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Malformed address with length %u `%s'\n",
411 GNUNET_a2s(addr, addrlen));
415 return GNUNET_ATS_address_get_type(GST_ats, addr, addrlen);
420 * Function called by ATS to notify the callee that the
421 * assigned bandwidth or address for a given peer was changed. If the
422 * callback is called with address/bandwidth assignments of zero, the
423 * ATS disconnect function will still be called once the disconnect
427 * @param address address to use (for peer given in address)
428 * @param session session to use (if available)
429 * @param bandwidth_out assigned outbound bandwidth for the connection, 0 to disconnect from peer
430 * @param bandwidth_in assigned inbound bandwidth for the connection, 0 to disconnect from peer
431 * @param ats ATS information
432 * @param ats_count number of ATS elements
435 ats_request_address_change (void *cls,
436 const struct GNUNET_HELLO_Address *address,
437 struct Session *session,
438 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
439 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
440 const struct GNUNET_ATS_Information *ats,
443 uint32_t bw_in = ntohl (bandwidth_in.value__);
444 uint32_t bw_out = ntohl (bandwidth_out.value__);
446 /* ATS tells me to disconnect from peer */
447 if ((bw_in == 0) && (bw_out == 0))
449 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
450 "ATS tells me to disconnect from peer `%s'\n",
451 GNUNET_i2s (&address->peer));
452 GST_neighbours_force_disconnect (&address->peer);
455 GST_neighbours_switch_to_address (&address->peer, address, session, ats,
456 ats_count, bandwidth_in,
462 * Function called to notify transport users that another
463 * peer connected to us.
466 * @param peer the peer that connected
467 * @param ats performance data
468 * @param ats_count number of entries in ats
469 * @param bandwidth_in inbound bandwidth in NBO
470 * @param bandwidth_out outbound bandwidth in NBO
473 neighbours_connect_notification (void *cls,
474 const struct GNUNET_PeerIdentity *peer,
475 const struct GNUNET_ATS_Information *ats,
477 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
478 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out)
481 sizeof (struct ConnectInfoMessage) +
482 ats_count * sizeof (struct GNUNET_ATS_Information);
483 char buf[len] GNUNET_ALIGN;
484 struct ConnectInfoMessage *connect_msg = (struct ConnectInfoMessage *) buf;
485 struct GNUNET_ATS_Information *ap;
488 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
489 "We are now connected to peer `%s' and %u peers in total\n",
490 GNUNET_i2s (peer), connections);
492 connect_msg->header.size = htons (sizeof (buf));
493 connect_msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
494 connect_msg->ats_count = htonl (ats_count);
495 connect_msg->id = *peer;
496 connect_msg->quota_in = bandwidth_in;
497 connect_msg->quota_out = bandwidth_out;
498 ap = (struct GNUNET_ATS_Information *) &connect_msg[1];
499 memcpy (ap, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
500 GST_clients_broadcast (&connect_msg->header, GNUNET_NO);
505 * Function called to notify transport users that another
506 * peer disconnected from us.
509 * @param peer the peer that disconnected
512 neighbours_disconnect_notification (void *cls,
513 const struct GNUNET_PeerIdentity *peer)
515 struct DisconnectInfoMessage disconnect_msg;
518 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
519 "Peer `%s' disconnected and we are connected to %u peers\n",
520 GNUNET_i2s (peer), connections);
522 disconnect_msg.header.size = htons (sizeof (struct DisconnectInfoMessage));
523 disconnect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT);
524 disconnect_msg.reserved = htonl (0);
525 disconnect_msg.peer = *peer;
526 GST_clients_broadcast (&disconnect_msg.header, GNUNET_NO);
531 * Function called to notify transport users that a neighbour peer changed its
535 * @param peer peer this update is about (never NULL)
536 * @param address address, NULL on disconnect
539 neighbours_address_notification (void *cls,
540 const struct GNUNET_PeerIdentity *peer,
541 const struct GNUNET_HELLO_Address *address)
543 GST_clients_broadcast_address_notification (peer, address);
548 * Function called when the service shuts down. Unloads our plugins
549 * and cancels pending validations.
551 * @param cls closure, unused
552 * @param tc task context (unused)
555 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
557 if (NULL != GST_keygen)
559 GNUNET_CRYPTO_rsa_key_create_stop (GST_keygen);
562 GST_neighbours_stop ();
563 GST_validation_stop ();
564 GST_plugins_unload ();
566 GNUNET_ATS_scheduling_done (GST_ats);
569 GST_blacklist_stop ();
572 if (NULL != GST_peerinfo)
574 GNUNET_PEERINFO_disconnect (GST_peerinfo);
577 if (NULL != GST_stats)
579 GNUNET_STATISTICS_destroy (GST_stats, GNUNET_NO);
582 if (NULL != GST_my_private_key)
584 GNUNET_CRYPTO_rsa_key_free (GST_my_private_key);
585 GST_my_private_key = NULL;
592 * Callback for hostkey read/generation
595 * @param pk the private key
596 * @param emsg error message
599 key_generation_cb (void *cls,
600 struct GNUNET_CRYPTO_RsaPrivateKey *pk,
603 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded tmp;
608 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
609 _("Transport service could not access hostkey: %s. Exiting.\n"),
611 GNUNET_SCHEDULER_shutdown ();
614 GST_my_private_key = pk;
616 GST_stats = GNUNET_STATISTICS_create ("transport", GST_cfg);
617 if (NULL == GST_stats)
619 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
620 _("Could not access STATISTICS service. Exiting.\n"));
621 GNUNET_SCHEDULER_shutdown ();
624 GST_peerinfo = GNUNET_PEERINFO_connect (GST_cfg);
625 memset (&GST_my_public_key, '\0', sizeof (GST_my_public_key));
626 memset (&tmp, '\0', sizeof (tmp));
627 GNUNET_CRYPTO_rsa_key_get_public (GST_my_private_key, &GST_my_public_key);
628 GNUNET_CRYPTO_hash (&GST_my_public_key, sizeof (GST_my_public_key),
629 &GST_my_identity.hashPubKey);
631 GNUNET_assert (NULL != GST_my_private_key);
632 GNUNET_assert (0 != memcmp (&GST_my_public_key, &tmp, sizeof (GST_my_public_key)));
634 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
636 if (NULL == GST_peerinfo)
638 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
639 _("Could not access PEERINFO service. Exiting.\n"));
640 GNUNET_SCHEDULER_shutdown ();
644 /* start subsystems */
645 GST_hello_start (&process_hello_update, NULL);
646 GNUNET_assert (NULL != GST_hello_get());
647 GST_blacklist_start (GST_server);
649 GNUNET_ATS_scheduling_init (GST_cfg, &ats_request_address_change, NULL);
650 GST_plugins_load (&plugin_env_receive_callback,
651 &plugin_env_address_change_notification,
652 &plugin_env_session_end,
653 &plugin_env_address_to_type);
654 GST_neighbours_start (NULL,
655 &neighbours_connect_notification,
656 &neighbours_disconnect_notification,
657 &neighbours_address_notification);
658 GST_clients_start (GST_server);
659 GST_validation_start ();
660 if (NULL != GST_server)
661 GNUNET_SERVER_resume (GST_server);
666 * Initiate transport service.
669 * @param server the initialized server
670 * @param c configuration to use
673 run (void *cls, struct GNUNET_SERVER_Handle *server,
674 const struct GNUNET_CONFIGURATION_Handle *c)
681 GNUNET_CONFIGURATION_get_value_filename (c, "GNUNETD", "HOSTKEY",
684 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
686 ("Transport service is lacking key configuration settings. Exiting.\n"));
687 GNUNET_SCHEDULER_shutdown ();
691 GNUNET_CONFIGURATION_get_value_time (c, "transport", "HELLO_EXPIRATION",
694 hello_expiration = GNUNET_CONSTANTS_HELLO_ADDRESS_EXPIRATION;
697 GNUNET_SERVER_suspend (server);
698 GST_keygen = GNUNET_CRYPTO_rsa_key_create_start (keyfile, &key_generation_cb, NULL);
699 GNUNET_free (keyfile);
700 if (NULL == GST_keygen)
702 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
703 _("Transport service is unable to access hostkey. Exiting.\n"));
704 GNUNET_SCHEDULER_shutdown ();
710 * The main function for the transport service.
712 * @param argc number of arguments from the command line
713 * @param argv command line arguments
714 * @return 0 ok, 1 on error
717 main (int argc, char *const *argv)
720 GNUNET_SERVICE_run (argc, argv, "transport",
721 GNUNET_SERVICE_OPTION_NONE, &run, NULL)) ? 0 : 1;
724 /* end of file gnunet-service-transport.c */