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)
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 char buf[size] GNUNET_ALIGN;
167 ret = GNUNET_TIME_UNIT_ZERO;
168 do_forward = GNUNET_SYSERR;
169 ret = GST_neighbours_calculate_receive_delay (peer, msg_size, &do_forward);
171 if (!GST_neighbours_test_connected (peer))
174 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
175 "Discarded %u bytes type %u payload from peer `%s'\n", msg_size,
176 ntohs (message->type), GNUNET_i2s (peer));
178 GNUNET_STATISTICS_update (GST_stats,
180 ("# bytes payload discarded due to not connected peer "),
181 msg_size, GNUNET_NO);
185 if (do_forward != GNUNET_YES)
187 im = (struct InboundMessage *) buf;
188 im->header.size = htons (size);
189 im->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_RECV);
192 fprintf (stderr, "FIX THIS: %s:%u \n", __FILE__, __LINE__);
194 ap[ats_count].type = htonl (GNUNET_ATS_QUALITY_NET_DELAY);
195 ap[ats_count].value =
196 htonl ((uint32_t) GST_neighbour_get_latency (peer).rel_value);*/
197 memcpy (&im[1], message, ntohs (message->size));
199 GNUNET_ATS_address_add (GST_ats, address, session, NULL, 0);
200 GNUNET_ATS_address_update (GST_ats, address, session, NULL, 0);
201 GST_clients_broadcast (&im->header, GNUNET_YES);
208 * Function called by the transport for each received message.
209 * This function should also be called with "NULL" for the
210 * message to signal that the other peer disconnected.
212 * @param cls closure, const char* with the name of the plugin we received the message from
213 * @param peer (claimed) identity of the other peer
214 * @param message the message, NULL if we only care about
215 * learning about the delay until we should receive again -- FIXME!
216 * @param ats performance information
217 * @param ats_count number of records in ats
218 * @param session identifier used for this session (NULL for plugins
219 * that do not offer bi-directional communication to the sender
220 * using the same "connection")
221 * @param sender_address binary address of the sender (if we established the
222 * connection or are otherwise sure of it; should be NULL
223 * for inbound TCP/UDP connections since it it not clear
224 * that we could establish ourselves a connection to that
225 * IP address and get the same system)
226 * @param sender_address_len number of bytes in sender_address
227 * @return how long the plugin should wait until receiving more data
228 * (plugins that do not support this, can ignore the return value)
230 struct GNUNET_TIME_Relative
231 GST_receive_callback (void *cls, const struct GNUNET_PeerIdentity *peer,
232 const struct GNUNET_MessageHeader *message,
233 struct Session *session,
234 const char *sender_address,
235 uint16_t sender_address_len)
237 const char *plugin_name = cls;
238 struct GNUNET_TIME_Relative ret;
239 struct GNUNET_HELLO_Address address;
242 address.peer = *peer;
243 address.address = sender_address;
244 address.address_length = sender_address_len;
245 address.transport_name = plugin_name;
246 ret = GNUNET_TIME_UNIT_ZERO;
249 type = ntohs (message->type);
250 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received Message with type %u from peer `%s'\n", type, GNUNET_i2s (peer));
252 GNUNET_STATISTICS_update (GST_stats,
254 ("# bytes total received"),
255 ntohs (message->size), GNUNET_NO);
259 case GNUNET_MESSAGE_TYPE_HELLO:
260 GST_validation_handle_hello (message);
262 case GNUNET_MESSAGE_TYPE_TRANSPORT_PING:
263 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
264 "Processing `%s' from `%s'\n", "PING",
266 NULL) ? GST_plugins_a2s (&address) : "<inbound>");
267 GST_validation_handle_ping (peer, message, &address, session);
269 case GNUNET_MESSAGE_TYPE_TRANSPORT_PONG:
270 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
271 "Processing `%s' from `%s'\n", "PONG",
273 NULL) ? GST_plugins_a2s (&address) : "<inbound>");
274 GST_validation_handle_pong (peer, message);
276 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT:
277 GST_neighbours_handle_connect (message, peer, &address, session);
279 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT_ACK:
280 GST_neighbours_handle_connect_ack (message, peer, &address, session);
282 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_ACK:
283 GST_neighbours_handle_session_ack (message, peer, &address, session);
285 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT:
286 GST_neighbours_handle_disconnect_message (peer, message);
288 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE:
289 GST_neighbours_keepalive (peer);
291 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE_RESPONSE:
292 GST_neighbours_keepalive_response (peer);
295 /* should be payload */
296 GNUNET_STATISTICS_update (GST_stats,
298 ("# bytes payload received"),
299 ntohs (message->size), GNUNET_NO);
300 ret = process_payload (peer, &address, session, message);
304 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
305 "Allowing receive from peer %s to continue in %llu ms\n",
306 GNUNET_i2s (peer), (unsigned long long) ret.rel_value);
312 * Function that will be called for each address the transport
313 * is aware that it might be reachable under. Update our HELLO.
315 * @param cls name of the plugin (const char*)
316 * @param add_remove should the address added (YES) or removed (NO) from the
317 * set of valid addresses?
318 * @param addr one of the addresses of the host
319 * the specific address format depends on the transport
320 * @param addrlen length of the address
321 * @param dest_plugin destination plugin to use this address with
324 plugin_env_address_change_notification (void *cls, int add_remove,
325 const void *addr, size_t addrlen,
326 const char *dest_plugin)
328 struct GNUNET_HELLO_Address address;
330 address.peer = GST_my_identity;
331 address.transport_name = dest_plugin;
332 address.address = addr;
333 address.address_length = addrlen;
334 GST_hello_modify_addresses (add_remove, &address);
339 * Function that will be called whenever the plugin internally
340 * cleans up a session pointer and hence the service needs to
341 * discard all of those sessions as well. Plugins that do not
342 * use sessions can simply omit calling this function and always
343 * use NULL wherever a session pointer is needed. This function
344 * should be called BEFORE a potential "TransmitContinuation"
345 * from the "TransmitFunction".
348 * @param peer which peer was the session for
349 * @param session which session is being destoyed
352 plugin_env_session_end (void *cls, const struct GNUNET_PeerIdentity *peer,
353 struct Session *session)
355 const char *transport_name = cls;
356 struct GNUNET_HELLO_Address address;
358 GNUNET_assert (strlen (transport_name) > 0);
359 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Session %p to peer `%s' ended \n",
360 session, GNUNET_i2s (peer));
362 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
364 "Telling ATS to destroy session %p from peer %s\n",
365 session, GNUNET_i2s (peer));
366 address.peer = *peer;
367 address.address = NULL;
368 address.address_length = 0;
369 address.transport_name = transport_name;
370 GST_neighbours_session_terminated (peer, session);
372 /* Tell ATS that session has ended */
373 GNUNET_ATS_address_destroyed (GST_ats, &address, session);
378 * Function that will be called to figure if an address is an loopback,
379 * LAN, WAN etc. address
382 * @param addr binary address
383 * @param addrlen length of the address
384 * @return ATS Information containing the network type
386 static struct GNUNET_ATS_Information
387 plugin_env_address_to_type (void *cls,
388 const struct sockaddr *addr,
391 struct GNUNET_ATS_Information ats;
392 ats.type = htonl (GNUNET_ATS_NETWORK_TYPE);
393 ats.value = htonl (GNUNET_ATS_NET_UNSPECIFIED);
399 if (((addr->sa_family != AF_INET) && (addrlen != sizeof (struct sockaddr_in))) &&
400 ((addr->sa_family != AF_INET6) && (addrlen != sizeof (struct sockaddr_in6))) &&
401 (addr->sa_family != AF_UNIX))
403 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Malformed address with length %u `%s'\n",
405 GNUNET_a2s(addr, addrlen));
409 return GNUNET_ATS_address_get_type(GST_ats, addr, addrlen);
413 * Function that will be called to figure if an address is an loopback,
414 * LAN, WAN etc. address
417 * @param addr binary address
418 * @param addrlen length of the address
419 * @return ATS Information containing the network type
422 plugin_env_update_metrics (void *cls,
423 const struct GNUNET_PeerIdentity *peer,
425 uint16_t address_len,
426 struct Session *session,
427 struct GNUNET_ATS_Information *ats,
430 struct GNUNET_HELLO_Address haddress;
431 const char *plugin_name = cls;
433 if ((NULL == ats) || (0 == ats_count))
435 GNUNET_assert (NULL != GST_ats);
437 haddress.peer = *peer;
438 haddress.address = address;
439 haddress.address_length = address_len;
440 haddress.transport_name = plugin_name;
442 GNUNET_ATS_address_update (GST_ats, &haddress, session, ats, ats_count);
447 * Function called by ATS to notify the callee that the
448 * assigned bandwidth or address for a given peer was changed. If the
449 * callback is called with address/bandwidth assignments of zero, the
450 * ATS disconnect function will still be called once the disconnect
454 * @param address address to use (for peer given in address)
455 * @param session session to use (if available)
456 * @param bandwidth_out assigned outbound bandwidth for the connection, 0 to disconnect from peer
457 * @param bandwidth_in assigned inbound bandwidth for the connection, 0 to disconnect from peer
458 * @param ats ATS information
459 * @param ats_count number of ATS elements
462 ats_request_address_change (void *cls,
463 const struct GNUNET_HELLO_Address *address,
464 struct Session *session,
465 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
466 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
467 const struct GNUNET_ATS_Information *ats,
470 uint32_t bw_in = ntohl (bandwidth_in.value__);
471 uint32_t bw_out = ntohl (bandwidth_out.value__);
473 /* ATS tells me to disconnect from peer */
474 if ((bw_in == 0) && (bw_out == 0))
476 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
477 "ATS tells me to disconnect from peer `%s'\n",
478 GNUNET_i2s (&address->peer));
479 GST_neighbours_force_disconnect (&address->peer);
482 GST_neighbours_switch_to_address (&address->peer, address, session, ats,
483 ats_count, bandwidth_in,
489 * Function called to notify transport users that another
490 * peer connected to us.
493 * @param peer the peer that connected
494 * @param ats performance data
495 * @param ats_count number of entries in ats
496 * @param bandwidth_in inbound bandwidth in NBO
497 * @param bandwidth_out outbound bandwidth in NBO
500 neighbours_connect_notification (void *cls,
501 const struct GNUNET_PeerIdentity *peer,
502 const struct GNUNET_ATS_Information *ats,
504 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
505 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out)
508 sizeof (struct ConnectInfoMessage) +
509 ats_count * sizeof (struct GNUNET_ATS_Information);
510 char buf[len] GNUNET_ALIGN;
511 struct ConnectInfoMessage *connect_msg = (struct ConnectInfoMessage *) buf;
512 struct GNUNET_ATS_Information *ap;
515 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
516 "We are now connected to peer `%s' and %u peers in total\n",
517 GNUNET_i2s (peer), connections);
519 connect_msg->header.size = htons (sizeof (buf));
520 connect_msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
521 connect_msg->ats_count = htonl (ats_count);
522 connect_msg->id = *peer;
523 connect_msg->quota_in = bandwidth_in;
524 connect_msg->quota_out = bandwidth_out;
525 ap = (struct GNUNET_ATS_Information *) &connect_msg[1];
526 memcpy (ap, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
527 GST_clients_broadcast (&connect_msg->header, GNUNET_NO);
532 * Function called to notify transport users that another
533 * peer disconnected from us.
536 * @param peer the peer that disconnected
539 neighbours_disconnect_notification (void *cls,
540 const struct GNUNET_PeerIdentity *peer)
542 struct DisconnectInfoMessage disconnect_msg;
545 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
546 "Peer `%s' disconnected and we are connected to %u peers\n",
547 GNUNET_i2s (peer), connections);
549 disconnect_msg.header.size = htons (sizeof (struct DisconnectInfoMessage));
550 disconnect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT);
551 disconnect_msg.reserved = htonl (0);
552 disconnect_msg.peer = *peer;
553 GST_clients_broadcast (&disconnect_msg.header, GNUNET_NO);
558 * Function called to notify transport users that a neighbour peer changed its
562 * @param peer peer this update is about (never NULL)
563 * @param address address, NULL on disconnect
566 neighbours_address_notification (void *cls,
567 const struct GNUNET_PeerIdentity *peer,
568 const struct GNUNET_HELLO_Address *address)
570 GST_clients_broadcast_address_notification (peer, address);
575 * Function called when the service shuts down. Unloads our plugins
576 * and cancels pending validations.
578 * @param cls closure, unused
579 * @param tc task context (unused)
582 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
584 if (NULL != GST_keygen)
586 GNUNET_CRYPTO_ecc_key_create_stop (GST_keygen);
589 GST_neighbours_stop ();
590 GST_validation_stop ();
591 GST_plugins_unload ();
593 GNUNET_ATS_scheduling_done (GST_ats);
596 GST_blacklist_stop ();
598 GST_manipulation_stop ();
600 if (NULL != GST_peerinfo)
602 GNUNET_PEERINFO_disconnect (GST_peerinfo);
605 if (NULL != GST_stats)
607 GNUNET_STATISTICS_destroy (GST_stats, GNUNET_NO);
610 if (NULL != GST_my_private_key)
612 GNUNET_CRYPTO_ecc_key_free (GST_my_private_key);
613 GST_my_private_key = NULL;
620 * Callback for hostkey read/generation
623 * @param pk the private key
624 * @param emsg error message
627 key_generation_cb (void *cls,
628 struct GNUNET_CRYPTO_EccPrivateKey *pk,
631 long long unsigned int max_fd_cfg;
638 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
639 _("Transport service could not access hostkey: %s. Exiting.\n"),
641 GNUNET_SCHEDULER_shutdown ();
644 GST_my_private_key = pk;
646 GST_stats = GNUNET_STATISTICS_create ("transport", GST_cfg);
647 GST_peerinfo = GNUNET_PEERINFO_connect (GST_cfg);
648 GNUNET_CRYPTO_ecc_key_get_public (GST_my_private_key, &GST_my_public_key);
649 GNUNET_CRYPTO_hash (&GST_my_public_key, sizeof (GST_my_public_key),
650 &GST_my_identity.hashPubKey);
651 GNUNET_assert (NULL != GST_my_private_key);
653 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
655 if (NULL == GST_peerinfo)
657 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
658 _("Could not access PEERINFO service. Exiting.\n"));
659 GNUNET_SCHEDULER_shutdown ();
667 struct rlimit r_file;
668 if (0 == getrlimit (RLIMIT_NOFILE, &r_file))
670 max_fd_rlimit = r_file.rlim_cur;
671 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
672 "Maximum number of open files was: %u/%u\n", r_file.rlim_cur,
675 max_fd_rlimit = (9 * max_fd_rlimit) / 10; /* Keep 10% for rest of transport */
677 GNUNET_CONFIGURATION_get_value_number (GST_cfg, "transport", "MAX_FD", &max_fd_cfg);
679 if (max_fd_cfg > max_fd_rlimit)
682 max_fd = max_fd_rlimit;
683 if (max_fd < DEFAULT_MAX_FDS)
684 max_fd = DEFAULT_MAX_FDS;
686 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
687 "Limiting number of sockets to %u: validation %u, neighbors: %u\n",
688 max_fd, (max_fd / 3) , (max_fd / 3) * 2);
690 /* start subsystems */
691 GST_hello_start (&process_hello_update, NULL);
692 GNUNET_assert (NULL != GST_hello_get());
693 GST_blacklist_start (GST_server);
695 GNUNET_ATS_scheduling_init (GST_cfg, &ats_request_address_change, NULL);
696 GST_manipulation_init (GST_cfg, &plugin_env_update_metrics);
697 GST_plugins_load (&GST_manipulation_recv,
698 &plugin_env_address_change_notification,
699 &plugin_env_session_end,
700 &plugin_env_address_to_type,
701 &GST_manipulation_metrics_recv);
702 GST_neighbours_start (NULL,
703 &neighbours_connect_notification,
704 &neighbours_disconnect_notification,
705 &neighbours_address_notification,
707 GST_clients_start (GST_server);
708 GST_validation_start ((max_fd / 3));
709 if (NULL != GST_server)
710 GNUNET_SERVER_resume (GST_server);
715 * Initiate transport service.
718 * @param server the initialized server
719 * @param c configuration to use
722 run (void *cls, struct GNUNET_SERVER_Handle *server,
723 const struct GNUNET_CONFIGURATION_Handle *c)
730 GNUNET_CONFIGURATION_get_value_filename (c, "PEER", "PRIVATE_KEY",
733 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
735 ("Transport service is lacking key configuration settings. Exiting.\n"));
736 GNUNET_SCHEDULER_shutdown ();
740 GNUNET_CONFIGURATION_get_value_time (c, "transport", "HELLO_EXPIRATION",
743 hello_expiration = GNUNET_CONSTANTS_HELLO_ADDRESS_EXPIRATION;
746 GNUNET_SERVER_suspend (server);
747 GST_keygen = GNUNET_CRYPTO_ecc_key_create_start (keyfile, &key_generation_cb, NULL);
748 GNUNET_free (keyfile);
749 if (NULL == GST_keygen)
751 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
752 _("Transport service is unable to access hostkey. Exiting.\n"));
753 GNUNET_SCHEDULER_shutdown ();
759 * The main function for the transport service.
761 * @param argc number of arguments from the command line
762 * @param argv command line arguments
763 * @return 0 ok, 1 on error
766 main (int argc, char *const *argv)
769 GNUNET_SERVICE_run (argc, argv, "transport",
770 GNUNET_SERVICE_OPTION_NONE, &run, NULL)) ? 0 : 1;
773 /* end of file gnunet-service-transport.c */