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);
160 ret = GNUNET_TIME_UNIT_ZERO;
161 do_forward = GNUNET_SYSERR;
163 GST_neighbours_calculate_receive_delay (peer,
166 ntohs (message->size),
168 im = (struct InboundMessage*) buf;
169 im->header.size = htons (size);
170 im->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_RECV);
171 im->ats_count = htonl (0);
172 memcpy (&(im->peer), peer, sizeof (struct GNUNET_PeerIdentity));
173 memcpy (&im[1], message, ntohs (message->size));
178 GST_clients_broadcast (&im->header, GNUNET_YES);
181 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
182 _("Discarded %u bytes of type %u from %s: quota violated!\n"),
183 ntohs (message->size),
184 ntohs (message->type),
188 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
189 _("Discarded %u bytes of type %u from %s: connection is down!\n"),
190 ntohs (message->size),
191 ntohs (message->type),
193 /* FIXME: store until connection is up? This is virtually always a SETKEY and a PING... */
204 * Function called by the transport for each received message.
205 * This function should also be called with "NULL" for the
206 * message to signal that the other peer disconnected.
208 * @param cls closure, const char* with the name of the plugin we received the message from
209 * @param peer (claimed) identity of the other peer
210 * @param message the message, NULL if we only care about
211 * learning about the delay until we should receive again -- FIXME!
212 * @param ats performance information
213 * @param ats_count number of records in ats
214 * @param session identifier used for this session (NULL for plugins
215 * that do not offer bi-directional communication to the sender
216 * using the same "connection")
217 * @param sender_address binary address of the sender (if we established the
218 * connection or are otherwise sure of it; should be NULL
219 * for inbound TCP/UDP connections since it it not clear
220 * that we could establish ourselves a connection to that
221 * IP address and get the same system)
222 * @param sender_address_len number of bytes in sender_address
223 * @return how long the plugin should wait until receiving more data
224 * (plugins that do not support this, can ignore the return value)
226 static struct GNUNET_TIME_Relative
227 plugin_env_receive_callback (void *cls, const struct GNUNET_PeerIdentity *peer,
228 const struct GNUNET_MessageHeader *message,
229 const struct GNUNET_ATS_Information *ats,
230 uint32_t ats_count, struct Session *session,
231 const char *sender_address,
232 uint16_t sender_address_len)
234 const char *plugin_name = cls;
235 struct GNUNET_TIME_Relative ret;
238 ret = GNUNET_TIME_UNIT_ZERO;
241 type = ntohs (message->type);
244 case GNUNET_MESSAGE_TYPE_HELLO:
245 GST_validation_handle_hello (message);
247 case GNUNET_MESSAGE_TYPE_TRANSPORT_PING:
249 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
250 "Processing `%s' from `%s'\n", "PING",
251 (sender_address != NULL) ? GST_plugins_a2s (plugin_name,
256 GST_validation_handle_ping (peer, message, plugin_name, session,
257 sender_address, sender_address_len);
259 case GNUNET_MESSAGE_TYPE_TRANSPORT_PONG:
261 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
262 "Processing `%s' from `%s'\n", "PONG",
263 (sender_address != NULL) ? GST_plugins_a2s (plugin_name,
268 GST_validation_handle_pong (peer, message);
270 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT:
271 GST_neighbours_handle_connect (message,
273 plugin_name, sender_address, sender_address_len,
274 session, ats, ats_count);
275 (void) GST_blacklist_test_allowed (peer, NULL, &try_connect_if_allowed,
278 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT:
279 GST_neighbours_handle_disconnect_message (peer, message);
281 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE:
282 GST_neighbours_keepalive (peer);
285 /* should be payload */
286 ret = process_payload (peer,
293 /* FIXME: this should not be needed, and not sure it's good to have it, but without
294 this connections seem to go extra-slow */
295 if ((ats_count > 0) && (ats != NULL))
298 GNUNET_log_from (GNUNET_ERROR_TYPE_INFO | GNUNET_ERROR_TYPE_BULK,
300 "Giving ATS session %p of plugin %s for peer %s\n",
304 GNUNET_ATS_address_update (GST_ats, peer,
305 plugin_name, sender_address, sender_address_len,
311 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
312 "Allowing receive from peer %s to continue in %llu ms\n",
314 (unsigned long long) ret.rel_value);
321 * Function that will be called for each address the transport
322 * is aware that it might be reachable under. Update our HELLO.
324 * @param cls name of the plugin (const char*)
325 * @param add_remove should the address added (YES) or removed (NO) from the
326 * set of valid addresses?
327 * @param addr one of the addresses of the host
328 * the specific address format depends on the transport
329 * @param addrlen length of the address
332 plugin_env_address_change_notification (void *cls, int add_remove,
333 const void *addr, size_t addrlen)
335 const char *plugin_name = cls;
337 GST_hello_modify_addresses (add_remove, plugin_name, addr, addrlen);
342 * Function that will be called whenever the plugin internally
343 * cleans up a session pointer and hence the service needs to
344 * discard all of those sessions as well. Plugins that do not
345 * use sessions can simply omit calling this function and always
346 * use NULL wherever a session pointer is needed. This function
347 * should be called BEFORE a potential "TransmitContinuation"
348 * from the "TransmitFunction".
351 * @param peer which peer was the session for
352 * @param session which session is being destoyed
355 plugin_env_session_end (void *cls, const struct GNUNET_PeerIdentity *peer,
356 struct Session *session)
359 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
360 "Session %X to peer `%s' ended \n",
361 session, GNUNET_i2s (peer));
364 GNUNET_log_from (GNUNET_ERROR_TYPE_INFO | GNUNET_ERROR_TYPE_BULK,
366 "Telling ATS to destroy session %p from peer %s\n",
369 GNUNET_ATS_address_destroyed (GST_ats, peer, NULL, NULL, 0, session);
370 GST_neighbours_session_terminated (peer, session);
375 * Function called by ATS to notify the callee that the
376 * assigned bandwidth or address for a given peer was changed. If the
377 * callback is called with address/bandwidth assignments of zero, the
378 * ATS disconnect function will still be called once the disconnect
382 * @param peer identity of the peer
383 * @param plugin_name name of the transport plugin, NULL to disconnect
384 * @param session session to use (if available)
385 * @param plugin_addr address to use (if available)
386 * @param plugin_addr_len number of bytes in addr
387 * @param bandwidth_out assigned outbound bandwidth for the connection, 0 to disconnect from peer
388 * @param bandwidth_in assigned inbound bandwidth for the connection, 0 to disconnect from peer
391 ats_request_address_change (void *cls, const struct GNUNET_PeerIdentity *peer,
392 const char *plugin_name,
393 const void *plugin_addr, size_t plugin_addr_len,
394 struct Session *session,
395 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
396 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
397 const struct GNUNET_ATS_Information * ats,
400 uint32_t bw_in = ntohl (bandwidth_in.value__);
401 uint32_t bw_out = ntohl (bandwidth_out.value__);
402 struct QuotaSetMessage msg;
404 /* ATS tells me to disconnect from peer*/
405 if ((bw_in == 0) && (bw_out == 0))
408 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
409 "ATS tells me to disconnect from peer `%s'\n",
412 GST_neighbours_force_disconnect(peer);
416 GST_neighbours_switch_to_address (peer, plugin_name, plugin_addr,
417 plugin_addr_len, session, ats, ats_count);
419 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
420 "Sending outbound quota of %u Bps for peer `%s' to all clients\n",
421 ntohl (bandwidth_out.value__), GNUNET_i2s (peer));
423 msg.header.size = htons (sizeof (struct QuotaSetMessage));
424 msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA);
425 msg.quota = bandwidth_out;
427 GST_clients_broadcast (&msg.header, GNUNET_NO);
430 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
431 "Setting inbound quota of %u for peer `%s' to \n",
432 ntohl (bandwidth_in.value__), GNUNET_i2s (peer));
434 GST_neighbours_set_incoming_quota (peer, bandwidth_in);
439 * Function called to notify transport users that another
440 * peer connected to us.
443 * @param peer the peer that connected
444 * @param ats performance data
445 * @param ats_count number of entries in ats
448 neighbours_connect_notification (void *cls,
449 const struct GNUNET_PeerIdentity *peer,
450 const struct GNUNET_ATS_Information
451 *ats, uint32_t ats_count)
453 char buf[sizeof (struct ConnectInfoMessage) +
454 ats_count * sizeof (struct GNUNET_ATS_Information)];
455 struct ConnectInfoMessage *connect_msg = (struct ConnectInfoMessage *) buf;
457 connect_msg->header.size = htons (sizeof (buf));
458 connect_msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
459 connect_msg->ats_count = htonl (ats_count);
460 connect_msg->id = *peer;
461 memcpy (&connect_msg->ats, &connect_msg->ats,
462 ats_count * sizeof (struct GNUNET_ATS_Information));
463 GST_clients_broadcast (&connect_msg->header, GNUNET_NO);
468 * Function called to notify transport users that another
469 * peer disconnected from us.
472 * @param peer the peer that disconnected
475 neighbours_disconnect_notification (void *cls,
476 const struct GNUNET_PeerIdentity *peer)
478 struct DisconnectInfoMessage disconnect_msg;
480 disconnect_msg.header.size = htons (sizeof (struct DisconnectInfoMessage));
481 disconnect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT);
482 disconnect_msg.reserved = htonl (0);
483 disconnect_msg.peer = *peer;
484 GST_clients_broadcast (&disconnect_msg.header, GNUNET_NO);
489 * Function called when the service shuts down. Unloads our plugins
490 * and cancels pending validations.
492 * @param cls closure, unused
493 * @param tc task context (unused)
496 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
498 GST_validation_stop ();
499 GST_plugins_unload ();
500 GST_neighbours_stop ();
501 GNUNET_ATS_scheduling_done (GST_ats);
504 GST_blacklist_stop ();
507 if (GST_peerinfo != NULL)
509 GNUNET_PEERINFO_disconnect (GST_peerinfo);
512 if (GST_stats != NULL)
514 GNUNET_STATISTICS_destroy (GST_stats, GNUNET_NO);
517 if (GST_my_private_key != NULL)
519 GNUNET_CRYPTO_rsa_key_free (GST_my_private_key);
520 GST_my_private_key = NULL;
526 * Initiate transport service.
529 * @param server the initialized server
530 * @param c configuration to use
533 run (void *cls, struct GNUNET_SERVER_Handle *server,
534 const struct GNUNET_CONFIGURATION_Handle *c)
541 GNUNET_CONFIGURATION_get_value_filename (c, "GNUNETD", "HOSTKEY",
544 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
546 ("Transport service is lacking key configuration settings. Exiting.\n"));
547 GNUNET_SCHEDULER_shutdown ();
550 GST_my_private_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
551 GNUNET_free (keyfile);
552 if (GST_my_private_key == NULL)
554 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
555 _("Transport service could not access hostkey. Exiting.\n"));
556 GNUNET_SCHEDULER_shutdown ();
559 GST_stats = GNUNET_STATISTICS_create ("transport", c);
560 GST_peerinfo = GNUNET_PEERINFO_connect (c);
561 GNUNET_CRYPTO_rsa_key_get_public (GST_my_private_key, &GST_my_public_key);
562 GNUNET_CRYPTO_hash (&GST_my_public_key, sizeof (GST_my_public_key),
563 &GST_my_identity.hashPubKey);
564 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
566 if (GST_peerinfo == NULL)
568 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
569 _("Could not access PEERINFO service. Exiting.\n"));
570 GNUNET_SCHEDULER_shutdown ();
574 /* start subsystems */
575 GST_hello_start (&process_hello_update, NULL);
576 GST_blacklist_start (server);
577 GST_plugins_load (&plugin_env_receive_callback,
578 &plugin_env_address_change_notification,
579 &plugin_env_session_end);
580 GST_ats = GNUNET_ATS_scheduling_init (GST_cfg, &ats_request_address_change, NULL);
581 GST_neighbours_start (NULL, &neighbours_connect_notification,
582 &neighbours_disconnect_notification);
583 GST_clients_start (server);
584 GST_validation_start ();
589 * The main function for the transport service.
591 * @param argc number of arguments from the command line
592 * @param argv command line arguments
593 * @return 0 ok, 1 on error
596 main (int argc, char *const *argv)
599 GNUNET_SERVICE_run (argc, argv, "transport",
600 GNUNET_SERVICE_OPTION_NONE, &run, NULL)) ? 0 : 1;
603 /* end of file gnunet-service-transport-new.c */