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;
81 * Transmit our HELLO message to the given (connected) neighbour.
83 * @param cls the 'HELLO' message
84 * @param target a connected neighbour
85 * @param ats performance information (unused)
86 * @param ats_count number of records in ats (unused)
87 * @param address the address
90 transmit_our_hello (void *cls, const struct GNUNET_PeerIdentity *target,
91 const struct GNUNET_ATS_Information *ats,
93 const struct GNUNET_HELLO_Address *address)
95 const struct GNUNET_MessageHeader *hello = cls;
97 GST_neighbours_send (target, (const char *) hello, ntohs (hello->size),
98 GNUNET_CONSTANTS_HELLO_ADDRESS_EXPIRATION, NULL, NULL);
103 * My HELLO has changed. Tell everyone who should know.
106 * @param hello new HELLO
109 process_hello_update (void *cls, const struct GNUNET_MessageHeader *hello)
111 GST_clients_broadcast (hello, GNUNET_NO);
112 GST_neighbours_iterate (&transmit_our_hello, (void *) hello);
118 * We received some payload. Prepare to pass it on to our clients.
120 * @param peer (claimed) identity of the other peer
121 * @param address the address
122 * @param session session used
123 * @param msg the message to process
124 * @param ats performance information
125 * @param ats_count number of records in ats
126 * @return how long the plugin should wait until receiving more data
128 static struct GNUNET_TIME_Relative
129 process_payload (const struct GNUNET_PeerIdentity *peer,
130 const struct GNUNET_HELLO_Address *address,
131 struct Session *session,
132 const struct GNUNET_MessageHeader *message,
133 const struct GNUNET_ATS_Information *ats, uint32_t ats_count)
135 struct GNUNET_TIME_Relative ret;
137 struct InboundMessage *im;
138 size_t msg_size = ntohs (message->size);
140 sizeof (struct InboundMessage) + msg_size +
141 sizeof (struct GNUNET_ATS_Information) * (ats_count + 1);
143 struct GNUNET_ATS_Information *ap;
145 ret = GNUNET_TIME_UNIT_ZERO;
146 do_forward = GNUNET_SYSERR;
147 ret = GST_neighbours_calculate_receive_delay (peer, msg_size, &do_forward);
149 if (!GST_neighbours_test_connected (peer))
152 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
153 "Discarded %u bytes type %u payload from peer `%s'\n", msg_size,
154 ntohs (message->type), GNUNET_i2s (peer));
156 GNUNET_STATISTICS_update (GST_stats,
158 ("# bytes payload discarded due to not connected peer "),
159 msg_size, GNUNET_NO);
163 if (do_forward != GNUNET_YES)
165 im = (struct InboundMessage *) buf;
166 im->header.size = htons (size);
167 im->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_RECV);
168 im->ats_count = htonl (ats_count + 1);
170 ap = (struct GNUNET_ATS_Information *) &im[1];
171 memcpy (ap, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
172 ap[ats_count].type = htonl (GNUNET_ATS_QUALITY_NET_DELAY);
173 ap[ats_count].value =
174 htonl ((uint32_t) GST_neighbour_get_latency (peer).rel_value);
175 memcpy (&ap[ats_count + 1], message, ntohs (message->size));
177 GNUNET_ATS_address_update (GST_ats, address, session, ap, ats_count + 1);
178 GST_clients_broadcast (&im->header, GNUNET_YES);
185 * Function called by the transport for each received message.
186 * This function should also be called with "NULL" for the
187 * message to signal that the other peer disconnected.
189 * @param cls closure, const char* with the name of the plugin we received the message from
190 * @param peer (claimed) identity of the other peer
191 * @param message the message, NULL if we only care about
192 * learning about the delay until we should receive again -- FIXME!
193 * @param ats performance information
194 * @param ats_count number of records in ats
195 * @param session identifier used for this session (NULL for plugins
196 * that do not offer bi-directional communication to the sender
197 * using the same "connection")
198 * @param sender_address binary address of the sender (if we established the
199 * connection or are otherwise sure of it; should be NULL
200 * for inbound TCP/UDP connections since it it not clear
201 * that we could establish ourselves a connection to that
202 * IP address and get the same system)
203 * @param sender_address_len number of bytes in sender_address
204 * @return how long the plugin should wait until receiving more data
205 * (plugins that do not support this, can ignore the return value)
207 static struct GNUNET_TIME_Relative
208 plugin_env_receive_callback (void *cls, const struct GNUNET_PeerIdentity *peer,
209 const struct GNUNET_MessageHeader *message,
210 const struct GNUNET_ATS_Information *ats,
211 uint32_t ats_count, struct Session *session,
212 const char *sender_address,
213 uint16_t sender_address_len)
215 const char *plugin_name = cls;
216 struct GNUNET_TIME_Relative ret;
217 struct GNUNET_HELLO_Address address;
220 address.peer = *peer;
221 address.address = sender_address;
222 address.address_length = sender_address_len;
223 address.transport_name = plugin_name;
224 ret = GNUNET_TIME_UNIT_ZERO;
227 type = ntohs (message->type);
230 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received Message with type %u\n", type);
235 case GNUNET_MESSAGE_TYPE_HELLO:
236 GST_validation_handle_hello (message);
238 case GNUNET_MESSAGE_TYPE_TRANSPORT_PING:
240 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
241 "Processing `%s' from `%s'\n", "PING",
243 NULL) ? GST_plugins_a2s (&address) : "<inbound>");
245 GST_validation_handle_ping (peer, message, &address, session);
247 case GNUNET_MESSAGE_TYPE_TRANSPORT_PONG:
249 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
250 "Processing `%s' from `%s'\n", "PONG",
252 NULL) ? GST_plugins_a2s (&address) : "<inbound>");
254 GST_validation_handle_pong (peer, message);
256 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT:
257 GST_neighbours_handle_connect (message, peer, &address, session, ats,
260 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT_ACK:
261 GST_neighbours_handle_connect_ack (message, peer, &address, session, ats,
264 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_ACK:
265 GST_neighbours_handle_ack (message, peer, &address, session, ats,
268 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT:
269 GST_neighbours_handle_disconnect_message (peer, message);
271 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE:
272 GST_neighbours_keepalive (peer);
274 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE_RESPONSE:
275 GST_neighbours_keepalive_response (peer, ats, ats_count);
278 /* should be payload */
279 ret = process_payload (peer, &address, session, message, ats, ats_count);
284 /* FIXME: this should not be needed, and not sure it's good to have it, but without
285 * this connections seem to go extra-slow */
286 GNUNET_ATS_address_update (GST_ats, &address, session, ats, ats_count);
289 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
290 "Allowing receive from peer %s to continue in %llu ms\n",
291 GNUNET_i2s (peer), (unsigned long long) ret.rel_value);
298 * Function that will be called for each address the transport
299 * is aware that it might be reachable under. Update our HELLO.
301 * @param cls name of the plugin (const char*)
302 * @param add_remove should the address added (YES) or removed (NO) from the
303 * set of valid addresses?
304 * @param addr one of the addresses of the host
305 * the specific address format depends on the transport
306 * @param addrlen length of the address
309 plugin_env_address_change_notification (void *cls, int add_remove,
310 const void *addr, size_t addrlen)
312 const char *plugin_name = cls;
313 struct GNUNET_HELLO_Address address;
315 address.peer = GST_my_identity;
316 address.transport_name = plugin_name;
317 address.address = addr;
318 address.address_length = addrlen;
319 GST_hello_modify_addresses (add_remove, &address);
324 * Function that will be called whenever the plugin internally
325 * cleans up a session pointer and hence the service needs to
326 * discard all of those sessions as well. Plugins that do not
327 * use sessions can simply omit calling this function and always
328 * use NULL wherever a session pointer is needed. This function
329 * should be called BEFORE a potential "TransmitContinuation"
330 * from the "TransmitFunction".
333 * @param peer which peer was the session for
334 * @param session which session is being destoyed
337 plugin_env_session_end (void *cls, const struct GNUNET_PeerIdentity *peer,
338 struct Session *session)
340 const char *transport_name = cls;
341 struct GNUNET_HELLO_Address address;
343 GNUNET_assert (strlen (transport_name) > 0);
345 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Session %X to peer `%s' ended \n",
346 session, GNUNET_i2s (peer));
349 GNUNET_log_from (GNUNET_ERROR_TYPE_INFO | 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 GST_neighbours_session_terminated (peer, session);
358 GNUNET_ATS_address_destroyed (GST_ats, &address, session);
363 * Function that will be called to figure if an address is an loopback,
364 * LAN, WAN etc. address
367 * @param addr binary address
368 * @param addrlen length of the address
369 * @return ATS Information containing the network type
371 static const struct GNUNET_ATS_Information
372 plugin_env_address_to_type (void *cls,
373 const struct sockaddr *addr,
376 struct GNUNET_ATS_Information ats;
377 ats.type = htonl (GNUNET_ATS_NETWORK_TYPE);
378 ats.value = htonl (GNUNET_ATS_NET_UNSPECIFIED);
384 if (((addr->sa_family != AF_INET) && (addrlen != sizeof (struct sockaddr_in))) &&
385 ((addr->sa_family != AF_INET6) && (addrlen != sizeof (struct sockaddr_in6))) &&
386 (addr->sa_family != AF_UNIX))
388 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Malformed address with length %u `%s'\n",
390 GNUNET_a2s(addr, addrlen));
394 return GNUNET_ATS_address_get_type(GST_ats, addr, addrlen);
399 * Function called by ATS to notify the callee that the
400 * assigned bandwidth or address for a given peer was changed. If the
401 * callback is called with address/bandwidth assignments of zero, the
402 * ATS disconnect function will still be called once the disconnect
406 * @param address address to use (for peer given in address)
407 * @param session session to use (if available)
408 * @param bandwidth_out assigned outbound bandwidth for the connection, 0 to disconnect from peer
409 * @param bandwidth_in assigned inbound bandwidth for the connection, 0 to disconnect from peer
410 * @param ats ATS information
411 * @param number of ATS elements
414 ats_request_address_change (void *cls,
415 const struct GNUNET_HELLO_Address *address,
416 struct Session *session,
417 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
418 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
419 const struct GNUNET_ATS_Information *ats,
422 uint32_t bw_in = ntohl (bandwidth_in.value__);
423 uint32_t bw_out = ntohl (bandwidth_out.value__);
425 /* ATS tells me to disconnect from peer */
426 if ((bw_in == 0) && (bw_out == 0))
429 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
430 "ATS tells me to disconnect from peer `%s'\n",
431 GNUNET_i2s (&address->peer));
433 GST_neighbours_force_disconnect (&address->peer);
436 /* will never return GNUNET_YES since connection is to be established */
437 GST_neighbours_switch_to_address_3way (&address->peer, address, session, ats,
438 ats_count, bandwidth_in,
444 * Function called to notify transport users that another
445 * peer connected to us.
448 * @param peer the peer that connected
449 * @param ats performance data
450 * @param ats_count number of entries in ats
453 neighbours_connect_notification (void *cls,
454 const struct GNUNET_PeerIdentity *peer,
455 const struct GNUNET_ATS_Information *ats,
459 sizeof (struct ConnectInfoMessage) +
460 ats_count * sizeof (struct GNUNET_ATS_Information);
462 struct ConnectInfoMessage *connect_msg = (struct ConnectInfoMessage *) buf;
463 struct GNUNET_ATS_Information *ap;
465 connect_msg->header.size = htons (sizeof (buf));
466 connect_msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
467 connect_msg->ats_count = htonl (ats_count);
468 connect_msg->id = *peer;
469 ap = (struct GNUNET_ATS_Information *) &connect_msg[1];
470 memcpy (ap, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
471 GST_clients_broadcast (&connect_msg->header, GNUNET_NO);
476 * Function called to notify transport users that another
477 * peer disconnected from us.
480 * @param peer the peer that disconnected
483 neighbours_disconnect_notification (void *cls,
484 const struct GNUNET_PeerIdentity *peer)
486 struct DisconnectInfoMessage disconnect_msg;
488 disconnect_msg.header.size = htons (sizeof (struct DisconnectInfoMessage));
489 disconnect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT);
490 disconnect_msg.reserved = htonl (0);
491 disconnect_msg.peer = *peer;
492 GST_clients_broadcast (&disconnect_msg.header, GNUNET_NO);
497 * Function called when the service shuts down. Unloads our plugins
498 * and cancels pending validations.
500 * @param cls closure, unused
501 * @param tc task context (unused)
504 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
506 GST_neighbours_stop ();
507 GST_validation_stop ();
508 GST_plugins_unload ();
510 GNUNET_ATS_scheduling_done (GST_ats);
513 GST_blacklist_stop ();
516 if (GST_peerinfo != NULL)
518 GNUNET_PEERINFO_disconnect (GST_peerinfo);
521 if (GST_stats != NULL)
523 GNUNET_STATISTICS_destroy (GST_stats, GNUNET_NO);
526 if (GST_my_private_key != NULL)
528 GNUNET_CRYPTO_rsa_key_free (GST_my_private_key);
529 GST_my_private_key = NULL;
535 * Initiate transport service.
538 * @param server the initialized server
539 * @param c configuration to use
542 run (void *cls, struct GNUNET_SERVER_Handle *server,
543 const struct GNUNET_CONFIGURATION_Handle *c)
550 GNUNET_CONFIGURATION_get_value_filename (c, "GNUNETD", "HOSTKEY",
553 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
555 ("Transport service is lacking key configuration settings. Exiting.\n"));
556 GNUNET_SCHEDULER_shutdown ();
559 GST_my_private_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
560 GNUNET_free (keyfile);
561 if (GST_my_private_key == NULL)
563 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
564 _("Transport service could not access hostkey. Exiting.\n"));
565 GNUNET_SCHEDULER_shutdown ();
568 GST_stats = GNUNET_STATISTICS_create ("transport", c);
569 GST_peerinfo = GNUNET_PEERINFO_connect (c);
570 GNUNET_CRYPTO_rsa_key_get_public (GST_my_private_key, &GST_my_public_key);
571 GNUNET_CRYPTO_hash (&GST_my_public_key, sizeof (GST_my_public_key),
572 &GST_my_identity.hashPubKey);
573 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
575 if (GST_peerinfo == NULL)
577 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
578 _("Could not access PEERINFO service. Exiting.\n"));
579 GNUNET_SCHEDULER_shutdown ();
583 /* start subsystems */
584 GST_hello_start (&process_hello_update, NULL);
585 GST_blacklist_start (server);
587 GNUNET_ATS_scheduling_init (GST_cfg, &ats_request_address_change, NULL);
588 GST_plugins_load (&plugin_env_receive_callback,
589 &plugin_env_address_change_notification,
590 &plugin_env_session_end,
591 &plugin_env_address_to_type);
592 GST_neighbours_start (NULL, &neighbours_connect_notification,
593 &neighbours_disconnect_notification);
594 GST_clients_start (server);
595 GST_validation_start ();
600 * The main function for the transport service.
602 * @param argc number of arguments from the command line
603 * @param argv command line arguments
604 * @return 0 ok, 1 on error
607 main (int argc, char *const *argv)
610 GNUNET_SERVICE_run (argc, argv, "transport",
611 GNUNET_SERVICE_OPTION_NONE, &run, NULL)) ? 0 : 1;
614 /* end of file gnunet-service-transport-new.c */