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-new.c
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_peerinfo_service.h"
31 #include "gnunet_ats_service.h"
32 #include "gnunet-service-transport.h"
33 #include "gnunet-service-transport_blacklist.h"
34 #include "gnunet-service-transport_clients.h"
35 #include "gnunet-service-transport_hello.h"
36 #include "gnunet-service-transport_neighbours.h"
37 #include "gnunet-service-transport_plugins.h"
38 #include "gnunet-service-transport_validation.h"
39 #include "transport.h"
46 struct GNUNET_STATISTICS_Handle *GST_stats;
49 * Configuration handle.
51 const struct GNUNET_CONFIGURATION_Handle *GST_cfg;
54 * Configuration handle.
56 struct GNUNET_PeerIdentity GST_my_identity;
59 * Handle to peerinfo service.
61 struct GNUNET_PEERINFO_Handle *GST_peerinfo;
66 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded GST_my_public_key;
71 struct GNUNET_CRYPTO_RsaPrivateKey *GST_my_private_key;
76 struct GNUNET_ATS_SchedulingHandle *GST_ats;
80 * Transmit our HELLO message to the given (connected) neighbour.
82 * @param cls the 'HELLO' message
83 * @param target a connected neighbour
84 * @param ats performance information (unused)
85 * @param ats_count number of records in ats (unused)
86 * @param transport plugin
88 * @param addrlen address length
91 transmit_our_hello (void *cls, const struct GNUNET_PeerIdentity *target,
92 const struct GNUNET_ATS_Information *ats,
94 const char * transport,
98 const struct GNUNET_MessageHeader *hello = cls;
100 GST_neighbours_send (target, (const char *) hello, ntohs (hello->size),
101 GNUNET_CONSTANTS_HELLO_ADDRESS_EXPIRATION, NULL, NULL);
106 * My HELLO has changed. Tell everyone who should know.
109 * @param hello new HELLO
112 process_hello_update (void *cls, const struct GNUNET_MessageHeader *hello)
114 GST_clients_broadcast (hello, GNUNET_NO);
115 GST_neighbours_iterate (&transmit_our_hello, (void *) hello);
120 * Try to initiate a connection to the given peer if the blacklist
123 * @param cls closure (unused, NULL)
124 * @param peer identity of peer that was tested
125 * @param result GNUNET_OK if the connection is allowed,
129 try_connect_if_allowed (void *cls, const struct GNUNET_PeerIdentity *peer,
132 if (GNUNET_OK != result)
133 return; /* not allowed */
134 GST_neighbours_try_connect (peer);
139 * We received some payload. Prepare to pass it on to our clients.
141 * @param peer (claimed) identity of the other peer
142 * @param message the message, NULL if we only care about
143 * learning about the delay until we should receive again -- FIXME!
144 * @param ats performance information
145 * @param ats_count number of records in ats
146 * @return how long the plugin should wait until receiving more data
148 static struct GNUNET_TIME_Relative
149 process_payload (const struct GNUNET_PeerIdentity *peer,
150 const struct GNUNET_MessageHeader *message,
151 const struct GNUNET_ATS_Information *ats,
154 struct GNUNET_TIME_Relative ret;
156 struct InboundMessage *im;
157 size_t size = sizeof (struct InboundMessage) + ntohs (message->size) + sizeof (struct GNUNET_ATS_Information) * ats_count;
159 struct GNUNET_ATS_Information *ap;
161 ret = GNUNET_TIME_UNIT_ZERO;
162 do_forward = GNUNET_SYSERR;
164 GST_neighbours_calculate_receive_delay (peer,
167 ntohs (message->size),
169 im = (struct InboundMessage*) buf;
170 im->header.size = htons (size);
171 im->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_RECV);
172 im->ats_count = htonl (ats_count);
174 ap = (struct GNUNET_ATS_Information*) &im[1];
175 memcpy (ap, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
176 memcpy (&ap[ats_count], message, ntohs (message->size));
181 GST_clients_broadcast (&im->header, GNUNET_YES);
184 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
185 _("Discarded %u bytes of type %u from %s: quota violated or no neighbour record!\n"),
186 ntohs (message->size),
187 ntohs (message->type),
191 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
192 _("Discarded %u bytes of type %u from %s: connection is down!\n"),
193 ntohs (message->size),
194 ntohs (message->type),
196 /* FIXME: store until connection is up? This is virtually always a SETKEY and a PING... */
207 * Function called by the transport for each received message.
208 * This function should also be called with "NULL" for the
209 * message to signal that the other peer disconnected.
211 * @param cls closure, const char* with the name of the plugin we received the message from
212 * @param peer (claimed) identity of the other peer
213 * @param message the message, NULL if we only care about
214 * learning about the delay until we should receive again -- FIXME!
215 * @param ats performance information
216 * @param ats_count number of records in ats
217 * @param session identifier used for this session (NULL for plugins
218 * that do not offer bi-directional communication to the sender
219 * using the same "connection")
220 * @param sender_address binary address of the sender (if we established the
221 * connection or are otherwise sure of it; should be NULL
222 * for inbound TCP/UDP connections since it it not clear
223 * that we could establish ourselves a connection to that
224 * IP address and get the same system)
225 * @param sender_address_len number of bytes in sender_address
226 * @return how long the plugin should wait until receiving more data
227 * (plugins that do not support this, can ignore the return value)
229 static struct GNUNET_TIME_Relative
230 plugin_env_receive_callback (void *cls, const struct GNUNET_PeerIdentity *peer,
231 const struct GNUNET_MessageHeader *message,
232 const struct GNUNET_ATS_Information *ats,
233 uint32_t ats_count, 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;
241 ret = GNUNET_TIME_UNIT_ZERO;
244 type = ntohs (message->type);
247 case GNUNET_MESSAGE_TYPE_HELLO:
248 GST_validation_handle_hello (message);
250 case GNUNET_MESSAGE_TYPE_TRANSPORT_PING:
252 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
253 "Processing `%s' from `%s'\n", "PING",
254 (sender_address != NULL) ? GST_plugins_a2s (plugin_name,
259 GST_validation_handle_ping (peer, message, plugin_name, session,
260 sender_address, sender_address_len);
262 case GNUNET_MESSAGE_TYPE_TRANSPORT_PONG:
264 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
265 "Processing `%s' from `%s'\n", "PONG",
266 (sender_address != NULL) ? GST_plugins_a2s (plugin_name,
271 GST_validation_handle_pong (peer, message);
273 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT:
274 GST_neighbours_handle_connect (message,
276 plugin_name, sender_address, sender_address_len,
277 session, ats, ats_count);
278 (void) GST_blacklist_test_allowed (peer, NULL, &try_connect_if_allowed,
281 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT:
282 GST_neighbours_handle_disconnect_message (peer, message);
284 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE:
285 GST_neighbours_keepalive (peer);
289 /* should be payload */
290 ret = process_payload (peer,
297 /* FIXME: this should not be needed, and not sure it's good to have it, but without
298 this connections seem to go extra-slow */
299 GNUNET_ATS_address_update (GST_ats, peer,
300 plugin_name, sender_address, sender_address_len,
305 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
306 "Allowing receive from peer %s to continue in %llu ms\n",
308 (unsigned long long) ret.rel_value);
315 * Function that will be called for each address the transport
316 * is aware that it might be reachable under. Update our HELLO.
318 * @param cls name of the plugin (const char*)
319 * @param add_remove should the address added (YES) or removed (NO) from the
320 * set of valid addresses?
321 * @param addr one of the addresses of the host
322 * the specific address format depends on the transport
323 * @param addrlen length of the address
326 plugin_env_address_change_notification (void *cls, int add_remove,
327 const void *addr, size_t addrlen)
329 const char *plugin_name = cls;
331 GST_hello_modify_addresses (add_remove, plugin_name, addr, addrlen);
336 * Function that will be called whenever the plugin internally
337 * cleans up a session pointer and hence the service needs to
338 * discard all of those sessions as well. Plugins that do not
339 * use sessions can simply omit calling this function and always
340 * use NULL wherever a session pointer is needed. This function
341 * should be called BEFORE a potential "TransmitContinuation"
342 * from the "TransmitFunction".
345 * @param peer which peer was the session for
346 * @param session which session is being destoyed
349 plugin_env_session_end (void *cls, const struct GNUNET_PeerIdentity *peer,
350 struct Session *session)
353 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
354 "Session %X to peer `%s' ended \n",
355 session, GNUNET_i2s (peer));
358 GNUNET_log_from (GNUNET_ERROR_TYPE_INFO | GNUNET_ERROR_TYPE_BULK,
360 "Telling ATS to destroy session %p from peer %s\n",
363 GNUNET_ATS_address_destroyed (GST_ats, peer, NULL, NULL, 0, session);
364 GST_neighbours_session_terminated (peer, session);
369 * Function called by ATS to notify the callee that the
370 * assigned bandwidth or address for a given peer was changed. If the
371 * callback is called with address/bandwidth assignments of zero, the
372 * ATS disconnect function will still be called once the disconnect
376 * @param peer identity of the peer
377 * @param plugin_name name of the transport plugin, NULL to disconnect
378 * @param session session to use (if available)
379 * @param plugin_addr address to use (if available)
380 * @param plugin_addr_len number of bytes in addr
381 * @param bandwidth_out assigned outbound bandwidth for the connection, 0 to disconnect from peer
382 * @param bandwidth_in assigned inbound bandwidth for the connection, 0 to disconnect from peer
385 ats_request_address_change (void *cls, const struct GNUNET_PeerIdentity *peer,
386 const char *plugin_name,
387 const void *plugin_addr, size_t plugin_addr_len,
388 struct Session *session,
389 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
390 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
391 const struct GNUNET_ATS_Information * ats,
394 uint32_t bw_in = ntohl (bandwidth_in.value__);
395 uint32_t bw_out = ntohl (bandwidth_out.value__);
396 struct QuotaSetMessage msg;
398 /* ATS tells me to disconnect from peer*/
399 if ((bw_in == 0) && (bw_out == 0))
402 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
403 "ATS tells me to disconnect from peer `%s'\n",
406 GST_neighbours_force_disconnect(peer);
410 GST_neighbours_switch_to_address (peer, plugin_name, plugin_addr,
411 plugin_addr_len, session, ats, ats_count))
414 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
415 "Connection is not yet up, ignoring quota for now\n");
417 /* FIXME: maybe we should let ATS know somehow? This is a problem
418 with the design; ATS may assign bandwidth, but we don't use it;
419 the current ATS API doesn't give us a good way to sync the
420 connection status between ATS and TRANSPORT */
424 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
425 "Sending outbound quota of %u Bps for peer `%s' to all clients\n",
426 ntohl (bandwidth_out.value__), GNUNET_i2s (peer));
428 msg.header.size = htons (sizeof (struct QuotaSetMessage));
429 msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA);
430 msg.quota = bandwidth_out;
432 GST_clients_broadcast (&msg.header, GNUNET_NO);
434 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
435 "Setting inbound quota of %u for peer `%s' to \n",
436 ntohl (bandwidth_in.value__), GNUNET_i2s (peer));
438 GST_neighbours_set_incoming_quota (peer, bandwidth_in);
443 * Function called to notify transport users that another
444 * peer connected to us.
447 * @param peer the peer that connected
448 * @param ats performance data
449 * @param ats_count number of entries in ats
452 neighbours_connect_notification (void *cls,
453 const struct GNUNET_PeerIdentity *peer,
454 const struct GNUNET_ATS_Information
455 *ats, uint32_t ats_count)
457 size_t len = sizeof (struct ConnectInfoMessage) +
458 ats_count * sizeof (struct GNUNET_ATS_Information);
460 struct ConnectInfoMessage *connect_msg = (struct ConnectInfoMessage *) buf;
461 struct GNUNET_ATS_Information *ap;
463 connect_msg->header.size = htons (sizeof (buf));
464 connect_msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
465 connect_msg->ats_count = htonl (ats_count);
466 connect_msg->id = *peer;
467 ap = (struct GNUNET_ATS_Information *) &connect_msg[1];
469 ats_count * sizeof (struct GNUNET_ATS_Information));
470 GST_clients_broadcast (&connect_msg->header, GNUNET_NO);
475 * Function called to notify transport users that another
476 * peer disconnected from us.
479 * @param peer the peer that disconnected
482 neighbours_disconnect_notification (void *cls,
483 const struct GNUNET_PeerIdentity *peer)
485 struct DisconnectInfoMessage disconnect_msg;
487 disconnect_msg.header.size = htons (sizeof (struct DisconnectInfoMessage));
488 disconnect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT);
489 disconnect_msg.reserved = htonl (0);
490 disconnect_msg.peer = *peer;
491 GST_clients_broadcast (&disconnect_msg.header, GNUNET_NO);
496 * Function called when the service shuts down. Unloads our plugins
497 * and cancels pending validations.
499 * @param cls closure, unused
500 * @param tc task context (unused)
503 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
505 GST_validation_stop ();
506 GST_plugins_unload ();
507 GST_neighbours_stop ();
508 GNUNET_ATS_scheduling_done (GST_ats);
511 GST_blacklist_stop ();
514 if (GST_peerinfo != NULL)
516 GNUNET_PEERINFO_disconnect (GST_peerinfo);
519 if (GST_stats != NULL)
521 GNUNET_STATISTICS_destroy (GST_stats, GNUNET_NO);
524 if (GST_my_private_key != NULL)
526 GNUNET_CRYPTO_rsa_key_free (GST_my_private_key);
527 GST_my_private_key = NULL;
533 * Initiate transport service.
536 * @param server the initialized server
537 * @param c configuration to use
540 run (void *cls, struct GNUNET_SERVER_Handle *server,
541 const struct GNUNET_CONFIGURATION_Handle *c)
548 GNUNET_CONFIGURATION_get_value_filename (c, "GNUNETD", "HOSTKEY",
551 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
553 ("Transport service is lacking key configuration settings. Exiting.\n"));
554 GNUNET_SCHEDULER_shutdown ();
557 GST_my_private_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
558 GNUNET_free (keyfile);
559 if (GST_my_private_key == NULL)
561 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
562 _("Transport service could not access hostkey. Exiting.\n"));
563 GNUNET_SCHEDULER_shutdown ();
566 GST_stats = GNUNET_STATISTICS_create ("transport", c);
567 GST_peerinfo = GNUNET_PEERINFO_connect (c);
568 GNUNET_CRYPTO_rsa_key_get_public (GST_my_private_key, &GST_my_public_key);
569 GNUNET_CRYPTO_hash (&GST_my_public_key, sizeof (GST_my_public_key),
570 &GST_my_identity.hashPubKey);
571 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
573 if (GST_peerinfo == NULL)
575 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
576 _("Could not access PEERINFO service. Exiting.\n"));
577 GNUNET_SCHEDULER_shutdown ();
581 /* start subsystems */
582 GST_hello_start (&process_hello_update, NULL);
583 GST_blacklist_start (server);
584 GST_plugins_load (&plugin_env_receive_callback,
585 &plugin_env_address_change_notification,
586 &plugin_env_session_end);
587 GST_ats = GNUNET_ATS_scheduling_init (GST_cfg, &ats_request_address_change, NULL);
588 GST_neighbours_start (NULL, &neighbours_connect_notification,
589 &neighbours_disconnect_notification);
590 GST_clients_start (server);
591 GST_validation_start ();
596 * The main function for the transport service.
598 * @param argc number of arguments from the command line
599 * @param argv command line arguments
600 * @return 0 ok, 1 on error
603 main (int argc, char *const *argv)
606 GNUNET_SERVICE_run (argc, argv, "transport",
607 GNUNET_SERVICE_OPTION_NONE, &run, NULL)) ? 0 : 1;
610 /* end of file gnunet-service-transport-new.c */