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
93 * @param bandwidth_in inbound quota in NBO
94 * @param bandwidth_out outbound quota in NBO
97 transmit_our_hello (void *cls, const struct GNUNET_PeerIdentity *target,
98 const struct GNUNET_ATS_Information *ats,
100 const struct GNUNET_HELLO_Address *address,
101 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
102 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out)
104 const struct GNUNET_MessageHeader *hello = cls;
106 GST_neighbours_send (target, (const char *) hello, ntohs (hello->size),
107 GNUNET_CONSTANTS_HELLO_ADDRESS_EXPIRATION, NULL, NULL);
112 * My HELLO has changed. Tell everyone who should know.
115 * @param hello new HELLO
118 process_hello_update (void *cls, const struct GNUNET_MessageHeader *hello)
120 GST_clients_broadcast (hello, GNUNET_NO);
121 GST_neighbours_iterate (&transmit_our_hello, (void *) hello);
127 * We received some payload. Prepare to pass it on to our clients.
129 * @param peer (claimed) identity of the other peer
130 * @param address the address
131 * @param session session used
132 * @param message the message to process
133 * @param ats performance information
134 * @param ats_count number of records in ats
135 * @return how long the plugin should wait until receiving more data
137 static struct GNUNET_TIME_Relative
138 process_payload (const struct GNUNET_PeerIdentity *peer,
139 const struct GNUNET_HELLO_Address *address,
140 struct Session *session,
141 const struct GNUNET_MessageHeader *message,
142 const struct GNUNET_ATS_Information *ats, uint32_t ats_count)
144 struct GNUNET_TIME_Relative ret;
146 struct InboundMessage *im;
147 size_t msg_size = ntohs (message->size);
149 sizeof (struct InboundMessage) + msg_size +
150 sizeof (struct GNUNET_ATS_Information) * (ats_count + 1);
151 char buf[size] GNUNET_ALIGN;
152 struct GNUNET_ATS_Information *ap;
154 ret = GNUNET_TIME_UNIT_ZERO;
155 do_forward = GNUNET_SYSERR;
156 ret = GST_neighbours_calculate_receive_delay (peer, msg_size, &do_forward);
158 if (!GST_neighbours_test_connected (peer))
161 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
162 "Discarded %u bytes type %u payload from peer `%s'\n", msg_size,
163 ntohs (message->type), GNUNET_i2s (peer));
165 GNUNET_STATISTICS_update (GST_stats,
167 ("# bytes payload discarded due to not connected peer "),
168 msg_size, GNUNET_NO);
172 if (do_forward != GNUNET_YES)
174 im = (struct InboundMessage *) buf;
175 im->header.size = htons (size);
176 im->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_RECV);
177 im->ats_count = htonl (ats_count + 1);
179 ap = (struct GNUNET_ATS_Information *) &im[1];
180 memcpy (ap, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
181 ap[ats_count].type = htonl (GNUNET_ATS_QUALITY_NET_DELAY);
182 ap[ats_count].value =
183 htonl ((uint32_t) GST_neighbour_get_latency (peer).rel_value);
184 memcpy (&ap[ats_count + 1], message, ntohs (message->size));
186 GNUNET_ATS_address_add (GST_ats, address, session, ap, ats_count + 1);
187 GNUNET_ATS_address_update (GST_ats, address, session, ap, ats_count + 1);
188 GST_clients_broadcast (&im->header, GNUNET_YES);
195 * Function called by the transport for each received message.
196 * This function should also be called with "NULL" for the
197 * message to signal that the other peer disconnected.
199 * @param cls closure, const char* with the name of the plugin we received the message from
200 * @param peer (claimed) identity of the other peer
201 * @param message the message, NULL if we only care about
202 * learning about the delay until we should receive again -- FIXME!
203 * @param ats performance information
204 * @param ats_count number of records in ats
205 * @param session identifier used for this session (NULL for plugins
206 * that do not offer bi-directional communication to the sender
207 * using the same "connection")
208 * @param sender_address binary address of the sender (if we established the
209 * connection or are otherwise sure of it; should be NULL
210 * for inbound TCP/UDP connections since it it not clear
211 * that we could establish ourselves a connection to that
212 * IP address and get the same system)
213 * @param sender_address_len number of bytes in sender_address
214 * @return how long the plugin should wait until receiving more data
215 * (plugins that do not support this, can ignore the return value)
217 static struct GNUNET_TIME_Relative
218 plugin_env_receive_callback (void *cls, const struct GNUNET_PeerIdentity *peer,
219 const struct GNUNET_MessageHeader *message,
220 const struct GNUNET_ATS_Information *ats,
221 uint32_t ats_count, struct Session *session,
222 const char *sender_address,
223 uint16_t sender_address_len)
225 const char *plugin_name = cls;
226 struct GNUNET_TIME_Relative ret;
227 struct GNUNET_HELLO_Address address;
230 address.peer = *peer;
231 address.address = sender_address;
232 address.address_length = sender_address_len;
233 address.transport_name = plugin_name;
234 ret = GNUNET_TIME_UNIT_ZERO;
237 type = ntohs (message->type);
238 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received Message with type %u from peer `%s'\n", type, GNUNET_i2s (peer));
240 GNUNET_STATISTICS_update (GST_stats,
242 ("# bytes total received"),
243 ntohs (message->size), GNUNET_NO);
247 case GNUNET_MESSAGE_TYPE_HELLO:
248 GST_validation_handle_hello (message);
250 case GNUNET_MESSAGE_TYPE_TRANSPORT_PING:
251 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
252 "Processing `%s' from `%s'\n", "PING",
254 NULL) ? GST_plugins_a2s (&address) : "<inbound>");
255 GST_validation_handle_ping (peer, message, &address, session);
257 case GNUNET_MESSAGE_TYPE_TRANSPORT_PONG:
258 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
259 "Processing `%s' from `%s'\n", "PONG",
261 NULL) ? GST_plugins_a2s (&address) : "<inbound>");
262 GST_validation_handle_pong (peer, message);
264 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT:
265 GST_neighbours_handle_connect (message, peer, &address, session, ats,
268 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT_ACK:
269 GST_neighbours_handle_connect_ack (message, peer, &address, session, ats,
272 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_ACK:
273 GST_neighbours_handle_session_ack (message, peer, &address, session, ats,
276 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT:
277 GST_neighbours_handle_disconnect_message (peer, message);
279 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE:
280 GST_neighbours_keepalive (peer);
282 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE_RESPONSE:
283 GST_neighbours_keepalive_response (peer, ats, ats_count);
286 /* should be payload */
287 GNUNET_STATISTICS_update (GST_stats,
289 ("# bytes payload received"),
290 ntohs (message->size), GNUNET_NO);
291 ret = process_payload (peer, &address, session, message, ats, ats_count);
295 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
296 "Allowing receive from peer %s to continue in %llu ms\n",
297 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
312 * @param dest_plugin destination plugin to use this address with
315 plugin_env_address_change_notification (void *cls, int add_remove,
316 const void *addr, size_t addrlen,
317 const char *dest_plugin)
319 struct GNUNET_HELLO_Address address;
321 address.peer = GST_my_identity;
322 address.transport_name = dest_plugin;
323 address.address = addr;
324 address.address_length = addrlen;
325 GST_hello_modify_addresses (add_remove, &address);
330 * Function that will be called whenever the plugin internally
331 * cleans up a session pointer and hence the service needs to
332 * discard all of those sessions as well. Plugins that do not
333 * use sessions can simply omit calling this function and always
334 * use NULL wherever a session pointer is needed. This function
335 * should be called BEFORE a potential "TransmitContinuation"
336 * from the "TransmitFunction".
339 * @param peer which peer was the session for
340 * @param session which session is being destoyed
343 plugin_env_session_end (void *cls, const struct GNUNET_PeerIdentity *peer,
344 struct Session *session)
346 const char *transport_name = cls;
347 struct GNUNET_HELLO_Address address;
349 GNUNET_assert (strlen (transport_name) > 0);
350 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Session %p to peer `%s' ended \n",
351 session, GNUNET_i2s (peer));
353 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
355 "Telling ATS to destroy session %p from peer %s\n",
356 session, GNUNET_i2s (peer));
357 address.peer = *peer;
358 address.address = NULL;
359 address.address_length = 0;
360 address.transport_name = transport_name;
361 GST_neighbours_session_terminated (peer, session);
363 /* Tell ATS that session has ended */
364 GNUNET_ATS_address_destroyed (GST_ats, &address, session);
369 * Function that will be called to figure if an address is an loopback,
370 * LAN, WAN etc. address
373 * @param addr binary address
374 * @param addrlen length of the address
375 * @return ATS Information containing the network type
377 static struct GNUNET_ATS_Information
378 plugin_env_address_to_type (void *cls,
379 const struct sockaddr *addr,
382 struct GNUNET_ATS_Information ats;
383 ats.type = htonl (GNUNET_ATS_NETWORK_TYPE);
384 ats.value = htonl (GNUNET_ATS_NET_UNSPECIFIED);
390 if (((addr->sa_family != AF_INET) && (addrlen != sizeof (struct sockaddr_in))) &&
391 ((addr->sa_family != AF_INET6) && (addrlen != sizeof (struct sockaddr_in6))) &&
392 (addr->sa_family != AF_UNIX))
394 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Malformed address with length %u `%s'\n",
396 GNUNET_a2s(addr, addrlen));
398 return (const struct GNUNET_ATS_Information) ats;
400 return GNUNET_ATS_address_get_type(GST_ats, addr, addrlen);
405 * Function called by ATS to notify the callee that the
406 * assigned bandwidth or address for a given peer was changed. If the
407 * callback is called with address/bandwidth assignments of zero, the
408 * ATS disconnect function will still be called once the disconnect
412 * @param address address to use (for peer given in address)
413 * @param session session to use (if available)
414 * @param bandwidth_out assigned outbound bandwidth for the connection, 0 to disconnect from peer
415 * @param bandwidth_in assigned inbound bandwidth for the connection, 0 to disconnect from peer
416 * @param ats ATS information
417 * @param ats_count number of ATS elements
420 ats_request_address_change (void *cls,
421 const struct GNUNET_HELLO_Address *address,
422 struct Session *session,
423 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
424 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
425 const struct GNUNET_ATS_Information *ats,
428 uint32_t bw_in = ntohl (bandwidth_in.value__);
429 uint32_t bw_out = ntohl (bandwidth_out.value__);
431 /* ATS tells me to disconnect from peer */
432 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));
437 GST_neighbours_force_disconnect (&address->peer);
440 GST_neighbours_switch_to_address (&address->peer, address, session, ats,
441 ats_count, bandwidth_in,
447 * Function called to notify transport users that another
448 * peer connected to us.
451 * @param peer the peer that connected
452 * @param ats performance data
453 * @param ats_count number of entries in ats
454 * @param bandwidth_in inbound bandwidth in NBO
455 * @param bandwidth_out outbound bandwidth in NBO
458 neighbours_connect_notification (void *cls,
459 const struct GNUNET_PeerIdentity *peer,
460 const struct GNUNET_ATS_Information *ats,
462 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
463 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out)
466 sizeof (struct ConnectInfoMessage) +
467 ats_count * sizeof (struct GNUNET_ATS_Information);
468 char buf[len] GNUNET_ALIGN;
469 struct ConnectInfoMessage *connect_msg = (struct ConnectInfoMessage *) buf;
470 struct GNUNET_ATS_Information *ap;
473 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
474 "We are now connected to peer `%s' and %u peers in total\n",
475 GNUNET_i2s (peer), connections);
477 connect_msg->header.size = htons (sizeof (buf));
478 connect_msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
479 connect_msg->ats_count = htonl (ats_count);
480 connect_msg->id = *peer;
481 connect_msg->quota_in = bandwidth_in;
482 connect_msg->quota_out = bandwidth_out;
483 ap = (struct GNUNET_ATS_Information *) &connect_msg[1];
484 memcpy (ap, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
485 GST_clients_broadcast (&connect_msg->header, GNUNET_NO);
490 * Function called to notify transport users that another
491 * peer disconnected from us.
494 * @param peer the peer that disconnected
497 neighbours_disconnect_notification (void *cls,
498 const struct GNUNET_PeerIdentity *peer)
500 struct DisconnectInfoMessage disconnect_msg;
503 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
504 "Peer `%s' disconnected and we are connected to %u peers\n",
505 GNUNET_i2s (peer), connections);
507 disconnect_msg.header.size = htons (sizeof (struct DisconnectInfoMessage));
508 disconnect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT);
509 disconnect_msg.reserved = htonl (0);
510 disconnect_msg.peer = *peer;
511 GST_clients_broadcast (&disconnect_msg.header, GNUNET_NO);
516 * Function called to notify transport users that a neighbour peer changed its
520 * @param peer peer this update is about (never NULL)
521 * @param address address, NULL on disconnect
524 neighbours_address_notification (void *cls,
525 const struct GNUNET_PeerIdentity *peer,
526 const struct GNUNET_HELLO_Address *address)
528 GST_clients_broadcast_address_notification (peer, address);
533 * Function called when the service shuts down. Unloads our plugins
534 * and cancels pending validations.
536 * @param cls closure, unused
537 * @param tc task context (unused)
540 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
542 GST_neighbours_stop ();
543 GST_validation_stop ();
544 GST_plugins_unload ();
546 GNUNET_ATS_scheduling_done (GST_ats);
549 GST_blacklist_stop ();
552 if (GST_peerinfo != NULL)
554 GNUNET_PEERINFO_disconnect (GST_peerinfo);
557 if (GST_stats != NULL)
559 GNUNET_STATISTICS_destroy (GST_stats, GNUNET_NO);
562 if (GST_my_private_key != NULL)
564 GNUNET_CRYPTO_rsa_key_free (GST_my_private_key);
565 GST_my_private_key = NULL;
571 * Initiate transport service.
574 * @param server the initialized server
575 * @param c configuration to use
578 run (void *cls, struct GNUNET_SERVER_Handle *server,
579 const struct GNUNET_CONFIGURATION_Handle *c)
582 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded tmp;
586 GNUNET_CONFIGURATION_get_value_filename (c, "GNUNETD", "HOSTKEY",
589 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
591 ("Transport service is lacking key configuration settings. Exiting.\n"));
592 GNUNET_SCHEDULER_shutdown ();
595 GST_my_private_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
596 GNUNET_free (keyfile);
597 if (GST_my_private_key == NULL)
599 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
600 _("Transport service could not access hostkey. Exiting.\n"));
601 GNUNET_SCHEDULER_shutdown ();
604 GST_stats = GNUNET_STATISTICS_create ("transport", c);
605 GST_peerinfo = GNUNET_PEERINFO_connect (c);
606 memset (&GST_my_public_key, '\0', sizeof (GST_my_public_key));
607 memset (&tmp, '\0', sizeof (tmp));
608 GNUNET_CRYPTO_rsa_key_get_public (GST_my_private_key, &GST_my_public_key);
609 GNUNET_CRYPTO_hash (&GST_my_public_key, sizeof (GST_my_public_key),
610 &GST_my_identity.hashPubKey);
612 GNUNET_assert (NULL != GST_my_private_key);
613 GNUNET_assert (0 != memcmp (&GST_my_public_key, &tmp, sizeof (GST_my_public_key)));
615 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
617 if (GST_peerinfo == NULL)
619 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
620 _("Could not access PEERINFO service. Exiting.\n"));
621 GNUNET_SCHEDULER_shutdown ();
625 /* start subsystems */
626 GST_hello_start (&process_hello_update, NULL);
627 GNUNET_assert (NULL != GST_hello_get());
628 GST_blacklist_start (server);
630 GNUNET_ATS_scheduling_init (GST_cfg, &ats_request_address_change, NULL);
631 GST_plugins_load (&plugin_env_receive_callback,
632 &plugin_env_address_change_notification,
633 &plugin_env_session_end,
634 &plugin_env_address_to_type);
635 GST_neighbours_start (NULL,
636 &neighbours_connect_notification,
637 &neighbours_disconnect_notification,
638 &neighbours_address_notification);
639 GST_clients_start (server);
640 GST_validation_start ();
645 * The main function for the transport service.
647 * @param argc number of arguments from the command line
648 * @param argv command line arguments
649 * @return 0 ok, 1 on error
652 main (int argc, char *const *argv)
655 GNUNET_SERVICE_run (argc, argv, "transport",
656 GNUNET_SERVICE_OPTION_NONE, &run, NULL)) ? 0 : 1;
659 /* end of file gnunet-service-transport.c */