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);
147 char buf[size] GNUNET_ALIGN;
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_add (GST_ats, address, session, ap, ats_count + 1);
183 GNUNET_ATS_address_update (GST_ats, address, session, ap, ats_count + 1);
184 GST_clients_broadcast (&im->header, GNUNET_YES);
191 * Function called by the transport for each received message.
192 * This function should also be called with "NULL" for the
193 * message to signal that the other peer disconnected.
195 * @param cls closure, const char* with the name of the plugin we received the message from
196 * @param peer (claimed) identity of the other peer
197 * @param message the message, NULL if we only care about
198 * learning about the delay until we should receive again -- FIXME!
199 * @param ats performance information
200 * @param ats_count number of records in ats
201 * @param session identifier used for this session (NULL for plugins
202 * that do not offer bi-directional communication to the sender
203 * using the same "connection")
204 * @param sender_address binary address of the sender (if we established the
205 * connection or are otherwise sure of it; should be NULL
206 * for inbound TCP/UDP connections since it it not clear
207 * that we could establish ourselves a connection to that
208 * IP address and get the same system)
209 * @param sender_address_len number of bytes in sender_address
210 * @return how long the plugin should wait until receiving more data
211 * (plugins that do not support this, can ignore the return value)
213 static struct GNUNET_TIME_Relative
214 plugin_env_receive_callback (void *cls, const struct GNUNET_PeerIdentity *peer,
215 const struct GNUNET_MessageHeader *message,
216 const struct GNUNET_ATS_Information *ats,
217 uint32_t ats_count, struct Session *session,
218 const char *sender_address,
219 uint16_t sender_address_len)
221 const char *plugin_name = cls;
222 struct GNUNET_TIME_Relative ret;
223 struct GNUNET_HELLO_Address address;
226 address.peer = *peer;
227 address.address = sender_address;
228 address.address_length = sender_address_len;
229 address.transport_name = plugin_name;
230 ret = GNUNET_TIME_UNIT_ZERO;
233 type = ntohs (message->type);
234 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received Message with type %u from peer `%s'\n", type, GNUNET_i2s (peer));
236 GNUNET_STATISTICS_update (GST_stats,
238 ("# bytes total received"),
239 ntohs (message->size), GNUNET_NO);
243 case GNUNET_MESSAGE_TYPE_HELLO:
244 GST_validation_handle_hello (message);
246 case GNUNET_MESSAGE_TYPE_TRANSPORT_PING:
247 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
248 "Processing `%s' from `%s'\n", "PING",
250 NULL) ? GST_plugins_a2s (&address) : "<inbound>");
251 GST_validation_handle_ping (peer, message, &address, session);
253 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>");
258 GST_validation_handle_pong (peer, message);
260 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT:
261 GST_neighbours_handle_connect (message, peer, &address, session, ats,
264 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT_ACK:
265 GST_neighbours_handle_connect_ack (message, peer, &address, session, ats,
268 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_ACK:
269 GST_neighbours_handle_session_ack (message, peer, &address, session, ats,
272 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT:
273 GST_neighbours_handle_disconnect_message (peer, message);
275 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE:
276 GST_neighbours_keepalive (peer);
278 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE_RESPONSE:
279 GST_neighbours_keepalive_response (peer, ats, ats_count);
282 /* should be payload */
283 GNUNET_STATISTICS_update (GST_stats,
285 ("# bytes payload received"),
286 ntohs (message->size), GNUNET_NO);
287 ret = process_payload (peer, &address, session, message, ats, ats_count);
291 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
292 "Allowing receive from peer %s to continue in %llu ms\n",
293 GNUNET_i2s (peer), (unsigned long long) ret.rel_value);
299 * Function that will be called for each address the transport
300 * is aware that it might be reachable under. Update our HELLO.
302 * @param cls name of the plugin (const char*)
303 * @param add_remove should the address added (YES) or removed (NO) from the
304 * set of valid addresses?
305 * @param addr one of the addresses of the host
306 * the specific address format depends on the transport
307 * @param addrlen length of the address
310 plugin_env_address_change_notification (void *cls, int add_remove,
311 const void *addr, size_t addrlen)
313 const char *plugin_name = cls;
314 struct GNUNET_HELLO_Address address;
316 address.peer = GST_my_identity;
317 address.transport_name = plugin_name;
318 address.address = addr;
319 address.address_length = addrlen;
320 GST_hello_modify_addresses (add_remove, &address);
325 * Function that will be called whenever the plugin internally
326 * cleans up a session pointer and hence the service needs to
327 * discard all of those sessions as well. Plugins that do not
328 * use sessions can simply omit calling this function and always
329 * use NULL wherever a session pointer is needed. This function
330 * should be called BEFORE a potential "TransmitContinuation"
331 * from the "TransmitFunction".
334 * @param peer which peer was the session for
335 * @param session which session is being destoyed
338 plugin_env_session_end (void *cls, const struct GNUNET_PeerIdentity *peer,
339 struct Session *session)
341 const char *transport_name = cls;
342 struct GNUNET_HELLO_Address address;
345 GNUNET_assert (strlen (transport_name) > 0);
346 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Session %p to peer `%s' ended \n",
347 session, GNUNET_i2s (peer));
349 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
351 "Telling ATS to destroy session %p from peer %s\n",
352 session, GNUNET_i2s (peer));
353 address.peer = *peer;
354 address.address = NULL;
355 address.address_length = 0;
356 address.transport_name = transport_name;
357 ret = GST_neighbours_session_terminated (peer, session);
358 if (GNUNET_NO == ret)
360 /* This was a session currently not used by
361 * neighbours so we have to try to destroy it here */
362 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 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))
433 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
434 "ATS tells me to disconnect from peer `%s'\n",
435 GNUNET_i2s (&address->peer));
436 GST_neighbours_force_disconnect (&address->peer);
439 GST_neighbours_switch_to_address (&address->peer, address, session, ats,
440 ats_count, bandwidth_in,
446 * Function called to notify transport users that another
447 * peer connected to us.
450 * @param peer the peer that connected
451 * @param ats performance data
452 * @param ats_count number of entries in ats
455 neighbours_connect_notification (void *cls,
456 const struct GNUNET_PeerIdentity *peer,
457 const struct GNUNET_ATS_Information *ats,
461 sizeof (struct ConnectInfoMessage) +
462 ats_count * sizeof (struct GNUNET_ATS_Information);
463 char buf[len] GNUNET_ALIGN;
464 struct ConnectInfoMessage *connect_msg = (struct ConnectInfoMessage *) buf;
465 struct GNUNET_ATS_Information *ap;
468 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
469 "We are now connected to peer `%s' and %u peers in total\n",
470 GNUNET_i2s (peer), connections);
472 connect_msg->header.size = htons (sizeof (buf));
473 connect_msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
474 connect_msg->ats_count = htonl (ats_count);
475 connect_msg->id = *peer;
476 ap = (struct GNUNET_ATS_Information *) &connect_msg[1];
477 memcpy (ap, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
478 GST_clients_broadcast (&connect_msg->header, GNUNET_NO);
483 * Function called to notify transport users that another
484 * peer disconnected from us.
487 * @param peer the peer that disconnected
490 neighbours_disconnect_notification (void *cls,
491 const struct GNUNET_PeerIdentity *peer)
493 struct DisconnectInfoMessage disconnect_msg;
496 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
497 "Peer `%s' disconnected and we are connected to %u peers\n",
498 GNUNET_i2s (peer), connections);
500 disconnect_msg.header.size = htons (sizeof (struct DisconnectInfoMessage));
501 disconnect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT);
502 disconnect_msg.reserved = htonl (0);
503 disconnect_msg.peer = *peer;
504 GST_clients_broadcast (&disconnect_msg.header, GNUNET_NO);
509 * Function called to notify transport users that a neighbour peer changed its
513 * @param peer peer this update is about (never NULL)
514 * @param address address, NULL on disconnect
517 neighbours_address_notification (void *cls,
518 const struct GNUNET_PeerIdentity *peer,
519 const struct GNUNET_HELLO_Address *address)
521 GST_clients_broadcast_address_notification (peer, address);
526 * Function called when the service shuts down. Unloads our plugins
527 * and cancels pending validations.
529 * @param cls closure, unused
530 * @param tc task context (unused)
533 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
535 GST_neighbours_stop ();
536 GST_validation_stop ();
537 GST_plugins_unload ();
539 GNUNET_ATS_scheduling_done (GST_ats);
542 GST_blacklist_stop ();
545 if (GST_peerinfo != NULL)
547 GNUNET_PEERINFO_disconnect (GST_peerinfo);
550 if (GST_stats != NULL)
552 GNUNET_STATISTICS_destroy (GST_stats, GNUNET_NO);
555 if (GST_my_private_key != NULL)
557 GNUNET_CRYPTO_rsa_key_free (GST_my_private_key);
558 GST_my_private_key = NULL;
564 * Initiate transport service.
567 * @param server the initialized server
568 * @param c configuration to use
571 run (void *cls, struct GNUNET_SERVER_Handle *server,
572 const struct GNUNET_CONFIGURATION_Handle *c)
575 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded tmp;
579 GNUNET_CONFIGURATION_get_value_filename (c, "GNUNETD", "HOSTKEY",
582 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
584 ("Transport service is lacking key configuration settings. Exiting.\n"));
585 GNUNET_SCHEDULER_shutdown ();
588 GST_my_private_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
589 GNUNET_free (keyfile);
590 if (GST_my_private_key == NULL)
592 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
593 _("Transport service could not access hostkey. Exiting.\n"));
594 GNUNET_SCHEDULER_shutdown ();
597 GST_stats = GNUNET_STATISTICS_create ("transport", c);
598 GST_peerinfo = GNUNET_PEERINFO_connect (c);
599 memset (&GST_my_public_key, '\0', sizeof (GST_my_public_key));
600 memset (&tmp, '\0', sizeof (tmp));
601 GNUNET_CRYPTO_rsa_key_get_public (GST_my_private_key, &GST_my_public_key);
602 GNUNET_CRYPTO_hash (&GST_my_public_key, sizeof (GST_my_public_key),
603 &GST_my_identity.hashPubKey);
605 GNUNET_assert (NULL != GST_my_private_key);
606 GNUNET_assert (0 != memcmp (&GST_my_public_key, &tmp, sizeof (GST_my_public_key)));
608 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
610 if (GST_peerinfo == NULL)
612 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
613 _("Could not access PEERINFO service. Exiting.\n"));
614 GNUNET_SCHEDULER_shutdown ();
618 /* start subsystems */
619 GST_hello_start (&process_hello_update, NULL);
620 GNUNET_assert (NULL != GST_hello_get());
621 GST_blacklist_start (server);
623 GNUNET_ATS_scheduling_init (GST_cfg, &ats_request_address_change, NULL);
624 GST_plugins_load (&plugin_env_receive_callback,
625 &plugin_env_address_change_notification,
626 &plugin_env_session_end,
627 &plugin_env_address_to_type);
628 GST_neighbours_start (NULL,
629 &neighbours_connect_notification,
630 &neighbours_disconnect_notification,
631 &neighbours_address_notification);
632 GST_clients_start (server);
633 GST_validation_start ();
638 * The main function for the transport service.
640 * @param argc number of arguments from the command line
641 * @param argv command line arguments
642 * @return 0 ok, 1 on error
645 main (int argc, char *const *argv)
648 GNUNET_SERVICE_run (argc, argv, "transport",
649 GNUNET_SERVICE_OPTION_NONE, &run, NULL)) ? 0 : 1;
652 /* end of file gnunet-service-transport.c */