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;
67 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded GST_my_public_key;
72 struct GNUNET_CRYPTO_RsaPrivateKey *GST_my_private_key;
77 struct GNUNET_ATS_SchedulingHandle *GST_ats;
80 * DEBUGGING connection counter
82 static int connections;
86 * Transmit our HELLO message to the given (connected) neighbour.
88 * @param cls the 'HELLO' message
89 * @param target a connected neighbour
90 * @param ats performance information (unused)
91 * @param ats_count number of records in ats (unused)
92 * @param address the address
95 transmit_our_hello (void *cls, const struct GNUNET_PeerIdentity *target,
96 const struct GNUNET_ATS_Information *ats,
98 const struct GNUNET_HELLO_Address *address)
100 const struct GNUNET_MessageHeader *hello = cls;
102 GST_neighbours_send (target, (const char *) hello, ntohs (hello->size),
103 GNUNET_CONSTANTS_HELLO_ADDRESS_EXPIRATION, NULL, NULL);
108 * My HELLO has changed. Tell everyone who should know.
111 * @param hello new HELLO
114 process_hello_update (void *cls, const struct GNUNET_MessageHeader *hello)
116 GST_clients_broadcast (hello, GNUNET_NO);
117 GST_neighbours_iterate (&transmit_our_hello, (void *) hello);
123 * We received some payload. Prepare to pass it on to our clients.
125 * @param peer (claimed) identity of the other peer
126 * @param address the address
127 * @param session session used
128 * @param message the message to process
129 * @param ats performance information
130 * @param ats_count number of records in ats
131 * @return how long the plugin should wait until receiving more data
133 static struct GNUNET_TIME_Relative
134 process_payload (const struct GNUNET_PeerIdentity *peer,
135 const struct GNUNET_HELLO_Address *address,
136 struct Session *session,
137 const struct GNUNET_MessageHeader *message,
138 const struct GNUNET_ATS_Information *ats, uint32_t ats_count)
140 struct GNUNET_TIME_Relative ret;
142 struct InboundMessage *im;
143 size_t msg_size = ntohs (message->size);
145 sizeof (struct InboundMessage) + msg_size +
146 sizeof (struct GNUNET_ATS_Information) * (ats_count + 1);
148 struct GNUNET_ATS_Information *ap;
150 ret = GNUNET_TIME_UNIT_ZERO;
151 do_forward = GNUNET_SYSERR;
152 ret = GST_neighbours_calculate_receive_delay (peer, msg_size, &do_forward);
154 if (!GST_neighbours_test_connected (peer))
157 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
158 "Discarded %u bytes type %u payload from peer `%s'\n", msg_size,
159 ntohs (message->type), GNUNET_i2s (peer));
161 GNUNET_STATISTICS_update (GST_stats,
163 ("# bytes payload discarded due to not connected peer "),
164 msg_size, GNUNET_NO);
168 if (do_forward != GNUNET_YES)
170 im = (struct InboundMessage *) buf;
171 im->header.size = htons (size);
172 im->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_RECV);
173 im->ats_count = htonl (ats_count + 1);
175 ap = (struct GNUNET_ATS_Information *) &im[1];
176 memcpy (ap, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
177 ap[ats_count].type = htonl (GNUNET_ATS_QUALITY_NET_DELAY);
178 ap[ats_count].value =
179 htonl ((uint32_t) GST_neighbour_get_latency (peer).rel_value);
180 memcpy (&ap[ats_count + 1], message, ntohs (message->size));
182 GNUNET_ATS_address_update (GST_ats, address, session, ap, ats_count + 1);
183 GST_clients_broadcast (&im->header, GNUNET_YES);
190 * Function called by the transport for each received message.
191 * This function should also be called with "NULL" for the
192 * message to signal that the other peer disconnected.
194 * @param cls closure, const char* with the name of the plugin we received the message from
195 * @param peer (claimed) identity of the other peer
196 * @param message the message, NULL if we only care about
197 * learning about the delay until we should receive again -- FIXME!
198 * @param ats performance information
199 * @param ats_count number of records in ats
200 * @param session identifier used for this session (NULL for plugins
201 * that do not offer bi-directional communication to the sender
202 * using the same "connection")
203 * @param sender_address binary address of the sender (if we established the
204 * connection or are otherwise sure of it; should be NULL
205 * for inbound TCP/UDP connections since it it not clear
206 * that we could establish ourselves a connection to that
207 * IP address and get the same system)
208 * @param sender_address_len number of bytes in sender_address
209 * @return how long the plugin should wait until receiving more data
210 * (plugins that do not support this, can ignore the return value)
212 static struct GNUNET_TIME_Relative
213 plugin_env_receive_callback (void *cls, const struct GNUNET_PeerIdentity *peer,
214 const struct GNUNET_MessageHeader *message,
215 const struct GNUNET_ATS_Information *ats,
216 uint32_t ats_count, struct Session *session,
217 const char *sender_address,
218 uint16_t sender_address_len)
220 const char *plugin_name = cls;
221 struct GNUNET_TIME_Relative ret;
222 struct GNUNET_HELLO_Address address;
225 address.peer = *peer;
226 address.address = sender_address;
227 address.address_length = sender_address_len;
228 address.transport_name = plugin_name;
229 ret = GNUNET_TIME_UNIT_ZERO;
232 type = ntohs (message->type);
235 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received Message with type %u\n", type);
240 case GNUNET_MESSAGE_TYPE_HELLO:
241 GST_validation_handle_hello (message);
243 case GNUNET_MESSAGE_TYPE_TRANSPORT_PING:
245 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
246 "Processing `%s' from `%s'\n", "PING",
248 NULL) ? GST_plugins_a2s (&address) : "<inbound>");
250 GST_validation_handle_ping (peer, message, &address, session);
252 case GNUNET_MESSAGE_TYPE_TRANSPORT_PONG:
254 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
255 "Processing `%s' from `%s'\n", "PONG",
257 NULL) ? GST_plugins_a2s (&address) : "<inbound>");
259 GST_validation_handle_pong (peer, message);
261 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT:
262 GST_neighbours_handle_connect (message, peer, &address, session, ats,
265 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT_ACK:
266 GST_neighbours_handle_connect_ack (message, peer, &address, session, ats,
269 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_ACK:
270 GST_neighbours_handle_ack (message, peer, &address, session, ats,
273 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT:
274 GST_neighbours_handle_disconnect_message (peer, message);
276 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE:
277 GST_neighbours_keepalive (peer);
279 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE_RESPONSE:
280 GST_neighbours_keepalive_response (peer, ats, ats_count);
283 /* should be payload */
284 ret = process_payload (peer, &address, session, message, ats, ats_count);
289 /* FIXME: this should not be needed, and not sure it's good to have it, but without
290 * this connections seem to go extra-slow */
291 GNUNET_ATS_address_update (GST_ats, &address, session, ats, ats_count);
294 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
295 "Allowing receive from peer %s to continue in %llu ms\n",
296 GNUNET_i2s (peer), (unsigned long long) ret.rel_value);
303 * Function that will be called for each address the transport
304 * is aware that it might be reachable under. Update our HELLO.
306 * @param cls name of the plugin (const char*)
307 * @param add_remove should the address added (YES) or removed (NO) from the
308 * set of valid addresses?
309 * @param addr one of the addresses of the host
310 * the specific address format depends on the transport
311 * @param addrlen length of the address
314 plugin_env_address_change_notification (void *cls, int add_remove,
315 const void *addr, size_t addrlen)
317 const char *plugin_name = cls;
318 struct GNUNET_HELLO_Address address;
320 address.peer = GST_my_identity;
321 address.transport_name = plugin_name;
322 address.address = addr;
323 address.address_length = addrlen;
324 GST_hello_modify_addresses (add_remove, &address);
329 * Function that will be called whenever the plugin internally
330 * cleans up a session pointer and hence the service needs to
331 * discard all of those sessions as well. Plugins that do not
332 * use sessions can simply omit calling this function and always
333 * use NULL wherever a session pointer is needed. This function
334 * should be called BEFORE a potential "TransmitContinuation"
335 * from the "TransmitFunction".
338 * @param peer which peer was the session for
339 * @param session which session is being destoyed
342 plugin_env_session_end (void *cls, const struct GNUNET_PeerIdentity *peer,
343 struct Session *session)
345 const char *transport_name = cls;
346 struct GNUNET_HELLO_Address address;
348 GNUNET_assert (strlen (transport_name) > 0);
350 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Session %X to peer `%s' ended \n",
351 session, GNUNET_i2s (peer));
354 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
356 "Telling ATS to destroy session %p from peer %s\n",
357 session, GNUNET_i2s (peer));
358 address.peer = *peer;
359 address.address = NULL;
360 address.address_length = 0;
361 address.transport_name = transport_name;
362 GST_neighbours_session_terminated (peer, session);
363 GNUNET_ATS_address_destroyed (GST_ats, &address, session);
368 * Function that will be called to figure if an address is an loopback,
369 * LAN, WAN etc. address
372 * @param addr binary address
373 * @param addrlen length of the address
374 * @return ATS Information containing the network type
376 static const struct GNUNET_ATS_Information
377 plugin_env_address_to_type (void *cls,
378 const struct sockaddr *addr,
381 struct GNUNET_ATS_Information ats;
382 ats.type = htonl (GNUNET_ATS_NETWORK_TYPE);
383 ats.value = htonl (GNUNET_ATS_NET_UNSPECIFIED);
389 if (((addr->sa_family != AF_INET) && (addrlen != sizeof (struct sockaddr_in))) &&
390 ((addr->sa_family != AF_INET6) && (addrlen != sizeof (struct sockaddr_in6))) &&
391 (addr->sa_family != AF_UNIX))
393 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Malformed address with length %u `%s'\n",
395 GNUNET_a2s(addr, addrlen));
397 return (const struct GNUNET_ATS_Information) ats;
399 return GNUNET_ATS_address_get_type(GST_ats, addr, addrlen);
404 * Function called by ATS to notify the callee that the
405 * assigned bandwidth or address for a given peer was changed. If the
406 * callback is called with address/bandwidth assignments of zero, the
407 * ATS disconnect function will still be called once the disconnect
411 * @param address address to use (for peer given in address)
412 * @param session session to use (if available)
413 * @param bandwidth_out assigned outbound bandwidth for the connection, 0 to disconnect from peer
414 * @param bandwidth_in assigned inbound bandwidth for the connection, 0 to disconnect from peer
415 * @param ats ATS information
416 * @param ats_count number of ATS elements
419 ats_request_address_change (void *cls,
420 const struct GNUNET_HELLO_Address *address,
421 struct Session *session,
422 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
423 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
424 const struct GNUNET_ATS_Information *ats,
427 uint32_t bw_in = ntohl (bandwidth_in.value__);
428 uint32_t bw_out = ntohl (bandwidth_out.value__);
430 /* ATS tells me to disconnect from peer */
431 if ((bw_in == 0) && (bw_out == 0))
434 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
435 "ATS tells me to disconnect from peer `%s'\n",
436 GNUNET_i2s (&address->peer));
438 GST_neighbours_force_disconnect (&address->peer);
441 /* will never return GNUNET_YES since connection is to be established */
442 GST_neighbours_switch_to_address (&address->peer, address, session, ats,
443 ats_count, bandwidth_in,
449 * Function called to notify transport users that another
450 * peer connected to us.
453 * @param peer the peer that connected
454 * @param ats performance data
455 * @param ats_count number of entries in ats
458 neighbours_connect_notification (void *cls,
459 const struct GNUNET_PeerIdentity *peer,
460 const struct GNUNET_ATS_Information *ats,
464 sizeof (struct ConnectInfoMessage) +
465 ats_count * sizeof (struct GNUNET_ATS_Information);
467 struct ConnectInfoMessage *connect_msg = (struct ConnectInfoMessage *) buf;
468 struct GNUNET_ATS_Information *ap;
471 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
472 "We are now connected to peer `%s' and %u peers in total\n",
473 GNUNET_i2s (peer), connections);
475 connect_msg->header.size = htons (sizeof (buf));
476 connect_msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
477 connect_msg->ats_count = htonl (ats_count);
478 connect_msg->id = *peer;
479 ap = (struct GNUNET_ATS_Information *) &connect_msg[1];
480 memcpy (ap, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
481 GST_clients_broadcast (&connect_msg->header, GNUNET_NO);
486 * Function called to notify transport users that another
487 * peer disconnected from us.
490 * @param peer the peer that disconnected
493 neighbours_disconnect_notification (void *cls,
494 const struct GNUNET_PeerIdentity *peer)
496 struct DisconnectInfoMessage disconnect_msg;
499 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
500 "Peer `%s' disconnected and we are connected to %u peers\n",
501 GNUNET_i2s (peer), connections);
503 disconnect_msg.header.size = htons (sizeof (struct DisconnectInfoMessage));
504 disconnect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT);
505 disconnect_msg.reserved = htonl (0);
506 disconnect_msg.peer = *peer;
507 GST_clients_broadcast (&disconnect_msg.header, GNUNET_NO);
512 * Function called to notify transport users that a neighbour peer changed its
516 * @param peer peer this update is about (never NULL)
517 * @param address address, NULL on disconnect
520 neighbours_address_notification (void *cls,
521 const struct GNUNET_PeerIdentity *peer,
522 const struct GNUNET_HELLO_Address *address)
524 GST_clients_broadcast_address_notification (peer, address);
529 * Function called when the service shuts down. Unloads our plugins
530 * and cancels pending validations.
532 * @param cls closure, unused
533 * @param tc task context (unused)
536 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
538 GST_neighbours_stop ();
539 GST_validation_stop ();
540 GST_plugins_unload ();
542 GNUNET_ATS_scheduling_done (GST_ats);
545 GST_blacklist_stop ();
548 if (GST_peerinfo != NULL)
550 GNUNET_PEERINFO_disconnect (GST_peerinfo);
553 if (GST_stats != NULL)
555 GNUNET_STATISTICS_destroy (GST_stats, GNUNET_NO);
558 if (GST_my_private_key != NULL)
560 GNUNET_CRYPTO_rsa_key_free (GST_my_private_key);
561 GST_my_private_key = NULL;
567 * Initiate transport service.
570 * @param server the initialized server
571 * @param c configuration to use
574 run (void *cls, struct GNUNET_SERVER_Handle *server,
575 const struct GNUNET_CONFIGURATION_Handle *c)
578 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded tmp;
582 GNUNET_CONFIGURATION_get_value_filename (c, "GNUNETD", "HOSTKEY",
585 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
587 ("Transport service is lacking key configuration settings. Exiting.\n"));
588 GNUNET_SCHEDULER_shutdown ();
591 GST_my_private_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
592 GNUNET_free (keyfile);
593 if (GST_my_private_key == NULL)
595 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
596 _("Transport service could not access hostkey. Exiting.\n"));
597 GNUNET_SCHEDULER_shutdown ();
600 GST_stats = GNUNET_STATISTICS_create ("transport", c);
601 GST_peerinfo = GNUNET_PEERINFO_connect (c);
602 memset (&GST_my_public_key, '\0', sizeof (GST_my_public_key));
603 memset (&tmp, '\0', sizeof (tmp));
604 GNUNET_CRYPTO_rsa_key_get_public (GST_my_private_key, &GST_my_public_key);
605 GNUNET_CRYPTO_hash (&GST_my_public_key, sizeof (GST_my_public_key),
606 &GST_my_identity.hashPubKey);
608 GNUNET_assert (NULL != GST_my_private_key);
609 GNUNET_assert (0 != memcmp (&GST_my_public_key, &tmp, sizeof (GST_my_public_key)));
611 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
613 if (GST_peerinfo == NULL)
615 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
616 _("Could not access PEERINFO service. Exiting.\n"));
617 GNUNET_SCHEDULER_shutdown ();
621 /* start subsystems */
622 GST_hello_start (&process_hello_update, NULL);
623 GNUNET_assert (NULL != GST_hello_get());
624 GST_blacklist_start (server);
626 GNUNET_ATS_scheduling_init (GST_cfg, &ats_request_address_change, NULL);
627 GST_plugins_load (&plugin_env_receive_callback,
628 &plugin_env_address_change_notification,
629 &plugin_env_session_end,
630 &plugin_env_address_to_type);
631 GST_neighbours_start (NULL,
632 &neighbours_connect_notification,
633 &neighbours_disconnect_notification,
634 &neighbours_address_notification);
635 GST_clients_start (server);
636 GST_validation_start ();
641 * The main function for the transport service.
643 * @param argc number of arguments from the command line
644 * @param argv command line arguments
645 * @return 0 ok, 1 on error
648 main (int argc, char *const *argv)
651 GNUNET_SERVICE_run (argc, argv, "transport",
652 GNUNET_SERVICE_OPTION_SOFT_SHUTDOWN, &run, NULL)) ? 0 : 1;
655 /* end of file gnunet-service-transport.c */