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 "gnunet-service-transport_manipulation.h"
41 #include "transport.h"
48 struct GNUNET_STATISTICS_Handle *GST_stats;
51 * Configuration handle.
53 const struct GNUNET_CONFIGURATION_Handle *GST_cfg;
56 * Configuration handle.
58 struct GNUNET_PeerIdentity GST_my_identity;
61 * Handle to peerinfo service.
63 struct GNUNET_PEERINFO_Handle *GST_peerinfo;
66 * Hostkey generation context
68 struct GNUNET_CRYPTO_EccKeyGenerationContext *GST_keygen;
71 * Handle to our service's server.
73 static struct GNUNET_SERVER_Handle *GST_server;
78 struct GNUNET_CRYPTO_EccPublicKeyBinaryEncoded GST_my_public_key;
83 struct GNUNET_CRYPTO_EccPrivateKey *GST_my_private_key;
88 struct GNUNET_ATS_SchedulingHandle *GST_ats;
91 * DEBUGGING connection counter
93 static int connections;
96 * Hello address expiration
98 struct GNUNET_TIME_Relative hello_expiration;
102 * Transmit our HELLO message to the given (connected) neighbour.
104 * @param cls the 'HELLO' message
105 * @param target a connected neighbour
106 * @param ats performance information (unused)
107 * @param ats_count number of records in ats (unused)
108 * @param address the address
109 * @param bandwidth_in inbound quota in NBO
110 * @param bandwidth_out outbound quota in NBO
113 transmit_our_hello (void *cls, const struct GNUNET_PeerIdentity *target,
114 const struct GNUNET_ATS_Information *ats,
116 const struct GNUNET_HELLO_Address *address,
117 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
118 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out)
120 const struct GNUNET_MessageHeader *hello = cls;
122 GST_neighbours_send (target, (const char *) hello, ntohs (hello->size),
123 hello_expiration, NULL, NULL);
128 * My HELLO has changed. Tell everyone who should know.
131 * @param hello new HELLO
134 process_hello_update (void *cls, const struct GNUNET_MessageHeader *hello)
136 GST_clients_broadcast (hello, GNUNET_NO);
137 GST_neighbours_iterate (&transmit_our_hello, (void *) hello);
143 * We received some payload. Prepare to pass it on to our clients.
145 * @param peer (claimed) identity of the other peer
146 * @param address the address
147 * @param session session used
148 * @param message the message to process
149 * @param ats performance information
150 * @param ats_count number of records in ats
151 * @return how long the plugin should wait until receiving more data
153 static struct GNUNET_TIME_Relative
154 process_payload (const struct GNUNET_PeerIdentity *peer,
155 const struct GNUNET_HELLO_Address *address,
156 struct Session *session,
157 const struct GNUNET_MessageHeader *message,
158 const struct GNUNET_ATS_Information *ats, uint32_t ats_count)
160 struct GNUNET_TIME_Relative ret;
162 struct InboundMessage *im;
163 size_t msg_size = ntohs (message->size);
165 sizeof (struct InboundMessage) + msg_size +
166 sizeof (struct GNUNET_ATS_Information) * (ats_count + 1);
167 char buf[size] GNUNET_ALIGN;
168 struct GNUNET_ATS_Information *ap;
170 ret = GNUNET_TIME_UNIT_ZERO;
171 do_forward = GNUNET_SYSERR;
172 ret = GST_neighbours_calculate_receive_delay (peer, msg_size, &do_forward);
174 if (!GST_neighbours_test_connected (peer))
177 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
178 "Discarded %u bytes type %u payload from peer `%s'\n", msg_size,
179 ntohs (message->type), GNUNET_i2s (peer));
181 GNUNET_STATISTICS_update (GST_stats,
183 ("# bytes payload discarded due to not connected peer "),
184 msg_size, GNUNET_NO);
188 if (do_forward != GNUNET_YES)
190 im = (struct InboundMessage *) buf;
191 im->header.size = htons (size);
192 im->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_RECV);
193 im->ats_count = htonl (ats_count + 1);
195 ap = (struct GNUNET_ATS_Information *) &im[1];
196 memcpy (ap, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
197 ap[ats_count].type = htonl (GNUNET_ATS_QUALITY_NET_DELAY);
198 ap[ats_count].value =
199 htonl ((uint32_t) GST_neighbour_get_latency (peer).rel_value);
200 memcpy (&ap[ats_count + 1], message, ntohs (message->size));
202 GNUNET_ATS_address_add (GST_ats, address, session, ap, ats_count + 1);
203 GNUNET_ATS_address_update (GST_ats, address, session, ap, ats_count + 1);
204 GST_clients_broadcast (&im->header, GNUNET_YES);
211 * Function called by the transport for each received message.
212 * This function should also be called with "NULL" for the
213 * message to signal that the other peer disconnected.
215 * @param cls closure, const char* with the name of the plugin we received the message from
216 * @param peer (claimed) identity of the other peer
217 * @param message the message, NULL if we only care about
218 * learning about the delay until we should receive again -- FIXME!
219 * @param ats performance information
220 * @param ats_count number of records in ats
221 * @param session identifier used for this session (NULL for plugins
222 * that do not offer bi-directional communication to the sender
223 * using the same "connection")
224 * @param sender_address binary address of the sender (if we established the
225 * connection or are otherwise sure of it; should be NULL
226 * for inbound TCP/UDP connections since it it not clear
227 * that we could establish ourselves a connection to that
228 * IP address and get the same system)
229 * @param sender_address_len number of bytes in sender_address
230 * @return how long the plugin should wait until receiving more data
231 * (plugins that do not support this, can ignore the return value)
233 struct GNUNET_TIME_Relative
234 GST_receive_callback (void *cls, const struct GNUNET_PeerIdentity *peer,
235 const struct GNUNET_MessageHeader *message,
236 const struct GNUNET_ATS_Information *ats,
237 uint32_t ats_count, struct Session *session,
238 const char *sender_address,
239 uint16_t sender_address_len)
241 const char *plugin_name = cls;
242 struct GNUNET_TIME_Relative ret;
243 struct GNUNET_HELLO_Address address;
246 address.peer = *peer;
247 address.address = sender_address;
248 address.address_length = sender_address_len;
249 address.transport_name = plugin_name;
250 ret = GNUNET_TIME_UNIT_ZERO;
253 type = ntohs (message->type);
254 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received Message with type %u from peer `%s'\n", type, GNUNET_i2s (peer));
256 GNUNET_STATISTICS_update (GST_stats,
258 ("# bytes total received"),
259 ntohs (message->size), GNUNET_NO);
263 case GNUNET_MESSAGE_TYPE_HELLO:
264 GST_validation_handle_hello (message);
266 case GNUNET_MESSAGE_TYPE_TRANSPORT_PING:
267 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
268 "Processing `%s' from `%s'\n", "PING",
270 NULL) ? GST_plugins_a2s (&address) : "<inbound>");
271 GST_validation_handle_ping (peer, message, &address, session);
273 case GNUNET_MESSAGE_TYPE_TRANSPORT_PONG:
274 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
275 "Processing `%s' from `%s'\n", "PONG",
277 NULL) ? GST_plugins_a2s (&address) : "<inbound>");
278 GST_validation_handle_pong (peer, message);
280 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT:
281 GST_neighbours_handle_connect (message, peer, &address, session, ats,
284 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT_ACK:
285 GST_neighbours_handle_connect_ack (message, peer, &address, session, ats,
288 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_ACK:
289 GST_neighbours_handle_session_ack (message, peer, &address, session, ats,
292 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT:
293 GST_neighbours_handle_disconnect_message (peer, message);
295 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE:
296 GST_neighbours_keepalive (peer);
298 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE_RESPONSE:
299 GST_neighbours_keepalive_response (peer, ats, ats_count);
302 /* should be payload */
303 GNUNET_STATISTICS_update (GST_stats,
305 ("# bytes payload received"),
306 ntohs (message->size), GNUNET_NO);
307 ret = process_payload (peer, &address, session, message, ats, ats_count);
311 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
312 "Allowing receive from peer %s to continue in %llu ms\n",
313 GNUNET_i2s (peer), (unsigned long long) ret.rel_value);
319 * Function that will be called for each address the transport
320 * is aware that it might be reachable under. Update our HELLO.
322 * @param cls name of the plugin (const char*)
323 * @param add_remove should the address added (YES) or removed (NO) from the
324 * set of valid addresses?
325 * @param addr one of the addresses of the host
326 * the specific address format depends on the transport
327 * @param addrlen length of the address
328 * @param dest_plugin destination plugin to use this address with
331 plugin_env_address_change_notification (void *cls, int add_remove,
332 const void *addr, size_t addrlen,
333 const char *dest_plugin)
335 struct GNUNET_HELLO_Address address;
337 address.peer = GST_my_identity;
338 address.transport_name = dest_plugin;
339 address.address = addr;
340 address.address_length = addrlen;
341 GST_hello_modify_addresses (add_remove, &address);
346 * Function that will be called whenever the plugin internally
347 * cleans up a session pointer and hence the service needs to
348 * discard all of those sessions as well. Plugins that do not
349 * use sessions can simply omit calling this function and always
350 * use NULL wherever a session pointer is needed. This function
351 * should be called BEFORE a potential "TransmitContinuation"
352 * from the "TransmitFunction".
355 * @param peer which peer was the session for
356 * @param session which session is being destoyed
359 plugin_env_session_end (void *cls, const struct GNUNET_PeerIdentity *peer,
360 struct Session *session)
362 const char *transport_name = cls;
363 struct GNUNET_HELLO_Address address;
365 GNUNET_assert (strlen (transport_name) > 0);
366 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Session %p to peer `%s' ended \n",
367 session, GNUNET_i2s (peer));
369 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
371 "Telling ATS to destroy session %p from peer %s\n",
372 session, GNUNET_i2s (peer));
373 address.peer = *peer;
374 address.address = NULL;
375 address.address_length = 0;
376 address.transport_name = transport_name;
377 GST_neighbours_session_terminated (peer, session);
379 /* Tell ATS that session has ended */
380 GNUNET_ATS_address_destroyed (GST_ats, &address, session);
385 * Function that will be called to figure if an address is an loopback,
386 * LAN, WAN etc. address
389 * @param addr binary address
390 * @param addrlen length of the address
391 * @return ATS Information containing the network type
393 static struct GNUNET_ATS_Information
394 plugin_env_address_to_type (void *cls,
395 const struct sockaddr *addr,
398 struct GNUNET_ATS_Information ats;
399 ats.type = htonl (GNUNET_ATS_NETWORK_TYPE);
400 ats.value = htonl (GNUNET_ATS_NET_UNSPECIFIED);
406 if (((addr->sa_family != AF_INET) && (addrlen != sizeof (struct sockaddr_in))) &&
407 ((addr->sa_family != AF_INET6) && (addrlen != sizeof (struct sockaddr_in6))) &&
408 (addr->sa_family != AF_UNIX))
410 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Malformed address with length %u `%s'\n",
412 GNUNET_a2s(addr, addrlen));
416 return GNUNET_ATS_address_get_type(GST_ats, addr, addrlen);
421 * Function called by ATS to notify the callee that the
422 * assigned bandwidth or address for a given peer was changed. If the
423 * callback is called with address/bandwidth assignments of zero, the
424 * ATS disconnect function will still be called once the disconnect
428 * @param address address to use (for peer given in address)
429 * @param session session to use (if available)
430 * @param bandwidth_out assigned outbound bandwidth for the connection, 0 to disconnect from peer
431 * @param bandwidth_in assigned inbound bandwidth for the connection, 0 to disconnect from peer
432 * @param ats ATS information
433 * @param ats_count number of ATS elements
436 ats_request_address_change (void *cls,
437 const struct GNUNET_HELLO_Address *address,
438 struct Session *session,
439 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
440 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
441 const struct GNUNET_ATS_Information *ats,
444 uint32_t bw_in = ntohl (bandwidth_in.value__);
445 uint32_t bw_out = ntohl (bandwidth_out.value__);
447 /* ATS tells me to disconnect from peer */
448 if ((bw_in == 0) && (bw_out == 0))
450 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
451 "ATS tells me to disconnect from peer `%s'\n",
452 GNUNET_i2s (&address->peer));
453 GST_neighbours_force_disconnect (&address->peer);
456 GST_neighbours_switch_to_address (&address->peer, address, session, ats,
457 ats_count, bandwidth_in,
463 * Function called to notify transport users that another
464 * peer connected to us.
467 * @param peer the peer that connected
468 * @param ats performance data
469 * @param ats_count number of entries in ats
470 * @param bandwidth_in inbound bandwidth in NBO
471 * @param bandwidth_out outbound bandwidth in NBO
474 neighbours_connect_notification (void *cls,
475 const struct GNUNET_PeerIdentity *peer,
476 const struct GNUNET_ATS_Information *ats,
478 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
479 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out)
482 sizeof (struct ConnectInfoMessage) +
483 ats_count * sizeof (struct GNUNET_ATS_Information);
484 char buf[len] GNUNET_ALIGN;
485 struct ConnectInfoMessage *connect_msg = (struct ConnectInfoMessage *) buf;
486 struct GNUNET_ATS_Information *ap;
489 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
490 "We are now connected to peer `%s' and %u peers in total\n",
491 GNUNET_i2s (peer), connections);
493 connect_msg->header.size = htons (sizeof (buf));
494 connect_msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
495 connect_msg->ats_count = htonl (ats_count);
496 connect_msg->id = *peer;
497 connect_msg->quota_in = bandwidth_in;
498 connect_msg->quota_out = bandwidth_out;
499 ap = (struct GNUNET_ATS_Information *) &connect_msg[1];
500 memcpy (ap, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
501 GST_clients_broadcast (&connect_msg->header, GNUNET_NO);
506 * Function called to notify transport users that another
507 * peer disconnected from us.
510 * @param peer the peer that disconnected
513 neighbours_disconnect_notification (void *cls,
514 const struct GNUNET_PeerIdentity *peer)
516 struct DisconnectInfoMessage disconnect_msg;
519 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
520 "Peer `%s' disconnected and we are connected to %u peers\n",
521 GNUNET_i2s (peer), connections);
523 disconnect_msg.header.size = htons (sizeof (struct DisconnectInfoMessage));
524 disconnect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT);
525 disconnect_msg.reserved = htonl (0);
526 disconnect_msg.peer = *peer;
527 GST_clients_broadcast (&disconnect_msg.header, GNUNET_NO);
532 * Function called to notify transport users that a neighbour peer changed its
536 * @param peer peer this update is about (never NULL)
537 * @param address address, NULL on disconnect
540 neighbours_address_notification (void *cls,
541 const struct GNUNET_PeerIdentity *peer,
542 const struct GNUNET_HELLO_Address *address)
544 GST_clients_broadcast_address_notification (peer, address);
549 * Function called when the service shuts down. Unloads our plugins
550 * and cancels pending validations.
552 * @param cls closure, unused
553 * @param tc task context (unused)
556 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
558 if (NULL != GST_keygen)
560 GNUNET_CRYPTO_ecc_key_create_stop (GST_keygen);
563 GST_neighbours_stop ();
564 GST_validation_stop ();
565 GST_plugins_unload ();
567 GNUNET_ATS_scheduling_done (GST_ats);
570 GST_blacklist_stop ();
572 GST_manipulation_stop ();
574 if (NULL != GST_peerinfo)
576 GNUNET_PEERINFO_disconnect (GST_peerinfo);
579 if (NULL != GST_stats)
581 GNUNET_STATISTICS_destroy (GST_stats, GNUNET_NO);
584 if (NULL != GST_my_private_key)
586 GNUNET_CRYPTO_ecc_key_free (GST_my_private_key);
587 GST_my_private_key = NULL;
594 * Callback for hostkey read/generation
597 * @param pk the private key
598 * @param emsg error message
601 key_generation_cb (void *cls,
602 struct GNUNET_CRYPTO_EccPrivateKey *pk,
605 long long unsigned int max_fd_cfg;
612 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
613 _("Transport service could not access hostkey: %s. Exiting.\n"),
615 GNUNET_SCHEDULER_shutdown ();
618 GST_my_private_key = pk;
620 GST_stats = GNUNET_STATISTICS_create ("transport", GST_cfg);
621 GST_peerinfo = GNUNET_PEERINFO_connect (GST_cfg);
622 GNUNET_CRYPTO_ecc_key_get_public (GST_my_private_key, &GST_my_public_key);
623 GNUNET_CRYPTO_hash (&GST_my_public_key, sizeof (GST_my_public_key),
624 &GST_my_identity.hashPubKey);
625 GNUNET_assert (NULL != GST_my_private_key);
627 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
629 if (NULL == GST_peerinfo)
631 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
632 _("Could not access PEERINFO service. Exiting.\n"));
633 GNUNET_SCHEDULER_shutdown ();
641 struct rlimit r_file;
642 if (0 == getrlimit (RLIMIT_NOFILE, &r_file))
644 max_fd_rlimit = r_file.rlim_cur;
645 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
646 "Maximum number of open files was: %u/%u\n", r_file.rlim_cur,
649 max_fd_rlimit = (9 * max_fd_rlimit) / 10; /* Keep 10% for rest of transport */
651 GNUNET_CONFIGURATION_get_value_number (GST_cfg, "transport", "MAX_FD", &max_fd_cfg);
653 if (max_fd_cfg > max_fd_rlimit)
656 max_fd = max_fd_rlimit;
657 if (max_fd < DEFAULT_MAX_FDS)
658 max_fd = DEFAULT_MAX_FDS;
660 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
661 "Limiting number of sockets to %u: validation %u, neighbors: %u\n",
662 max_fd, (max_fd / 3) , (max_fd / 3) * 2);
664 /* start subsystems */
665 GST_hello_start (&process_hello_update, NULL);
666 GNUNET_assert (NULL != GST_hello_get());
667 GST_blacklist_start (GST_server);
669 GNUNET_ATS_scheduling_init (GST_cfg, &ats_request_address_change, NULL);
670 GST_manipulation_init (GST_cfg);
671 GST_plugins_load (&GST_manipulation_recv,
672 &plugin_env_address_change_notification,
673 &plugin_env_session_end,
674 &plugin_env_address_to_type);
675 GST_neighbours_start (NULL,
676 &neighbours_connect_notification,
677 &neighbours_disconnect_notification,
678 &neighbours_address_notification,
680 GST_clients_start (GST_server);
681 GST_validation_start ((max_fd / 3));
682 if (NULL != GST_server)
683 GNUNET_SERVER_resume (GST_server);
688 * Initiate transport service.
691 * @param server the initialized server
692 * @param c configuration to use
695 run (void *cls, struct GNUNET_SERVER_Handle *server,
696 const struct GNUNET_CONFIGURATION_Handle *c)
703 GNUNET_CONFIGURATION_get_value_filename (c, "PEER", "PRIVATE_KEY",
706 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
708 ("Transport service is lacking key configuration settings. Exiting.\n"));
709 GNUNET_SCHEDULER_shutdown ();
713 GNUNET_CONFIGURATION_get_value_time (c, "transport", "HELLO_EXPIRATION",
716 hello_expiration = GNUNET_CONSTANTS_HELLO_ADDRESS_EXPIRATION;
719 GNUNET_SERVER_suspend (server);
720 GST_keygen = GNUNET_CRYPTO_ecc_key_create_start (keyfile, &key_generation_cb, NULL);
721 GNUNET_free (keyfile);
722 if (NULL == GST_keygen)
724 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
725 _("Transport service is unable to access hostkey. Exiting.\n"));
726 GNUNET_SCHEDULER_shutdown ();
732 * The main function for the transport service.
734 * @param argc number of arguments from the command line
735 * @param argv command line arguments
736 * @return 0 ok, 1 on error
739 main (int argc, char *const *argv)
742 GNUNET_SERVICE_run (argc, argv, "transport",
743 GNUNET_SERVICE_OPTION_NONE, &run, NULL)) ? 0 : 1;
746 /* end of file gnunet-service-transport.c */