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 message the message, never NULL
122 * @param ats performance information
123 * @param ats_count number of records in ats
124 * @return how long the plugin should wait until receiving more data
126 static struct GNUNET_TIME_Relative
127 process_payload (const struct GNUNET_PeerIdentity *peer,
128 const struct GNUNET_MessageHeader *message,
129 const struct GNUNET_ATS_Information *ats, uint32_t ats_count)
131 struct GNUNET_TIME_Relative ret;
133 struct InboundMessage *im;
134 size_t msg_size = ntohs (message->size);
136 sizeof (struct InboundMessage) + msg_size +
137 sizeof (struct GNUNET_ATS_Information) * (ats_count + 1);
139 struct GNUNET_ATS_Information *ap;
141 ret = GNUNET_TIME_UNIT_ZERO;
142 do_forward = GNUNET_SYSERR;
143 ret = GST_neighbours_calculate_receive_delay (peer, msg_size, &do_forward);
145 if (!GST_neighbours_test_connected (peer))
148 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
149 "Discarded %u bytes type %u payload from peer `%s'\n", msg_size,
150 ntohs (message->type), GNUNET_i2s (peer));
152 GNUNET_STATISTICS_update (GST_stats,
154 ("# bytes payload discarded due to not connected peer "),
155 msg_size, GNUNET_NO);
159 if (do_forward != GNUNET_YES)
161 im = (struct InboundMessage *) buf;
162 im->header.size = htons (size);
163 im->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_RECV);
164 im->ats_count = htonl (ats_count + 1);
166 ap = (struct GNUNET_ATS_Information *) &im[1];
167 memcpy (ap, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
168 ap[ats_count].type = htonl (GNUNET_ATS_QUALITY_NET_DELAY);
169 ap[ats_count].value = htonl ((uint32_t) GST_neighbour_get_latency (peer).rel_value);
170 memcpy (&ap[ats_count + 1], message, ntohs (message->size));
172 GST_clients_broadcast (&im->header, GNUNET_YES);
179 * Function called by the transport for each received message.
180 * This function should also be called with "NULL" for the
181 * message to signal that the other peer disconnected.
183 * @param cls closure, const char* with the name of the plugin we received the message from
184 * @param peer (claimed) identity of the other peer
185 * @param message the message, NULL if we only care about
186 * learning about the delay until we should receive again -- FIXME!
187 * @param ats performance information
188 * @param ats_count number of records in ats
189 * @param session identifier used for this session (NULL for plugins
190 * that do not offer bi-directional communication to the sender
191 * using the same "connection")
192 * @param sender_address binary address of the sender (if we established the
193 * connection or are otherwise sure of it; should be NULL
194 * for inbound TCP/UDP connections since it it not clear
195 * that we could establish ourselves a connection to that
196 * IP address and get the same system)
197 * @param sender_address_len number of bytes in sender_address
198 * @return how long the plugin should wait until receiving more data
199 * (plugins that do not support this, can ignore the return value)
201 static struct GNUNET_TIME_Relative
202 plugin_env_receive_callback (void *cls,
203 const struct GNUNET_PeerIdentity *peer,
204 const struct GNUNET_MessageHeader *message,
205 const struct GNUNET_ATS_Information *ats,
206 uint32_t ats_count, struct Session *session,
207 const char *sender_address,
208 uint16_t sender_address_len)
210 const char *plugin_name = cls;
211 struct GNUNET_TIME_Relative ret;
212 struct GNUNET_HELLO_Address address;
215 address.peer = *peer;
216 address.address = sender_address;
217 address.address_length = sender_address_len;
218 address.transport_name = plugin_name;
219 ret = GNUNET_TIME_UNIT_ZERO;
222 type = ntohs (message->type);
225 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received Message with type %u\n", type);
230 case GNUNET_MESSAGE_TYPE_HELLO:
231 GST_validation_handle_hello (message);
233 case GNUNET_MESSAGE_TYPE_TRANSPORT_PING:
235 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
236 "Processing `%s' from `%s'\n", "PING",
237 (sender_address != NULL) ? GST_plugins_a2s (&address)
240 GST_validation_handle_ping (peer, message, &address, session);
242 case GNUNET_MESSAGE_TYPE_TRANSPORT_PONG:
244 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
245 "Processing `%s' from `%s'\n", "PONG",
246 (sender_address != NULL) ? GST_plugins_a2s (&address)
249 GST_validation_handle_pong (peer, message);
251 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT:
252 GST_neighbours_handle_connect (message, peer, &address, session, ats, ats_count);
254 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT_ACK:
255 GST_neighbours_handle_connect_ack (message, peer, &address,
256 session, ats, ats_count);
258 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_ACK:
259 GST_neighbours_handle_ack (message, peer, &address, session, ats, ats_count);
261 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT:
262 GST_neighbours_handle_disconnect_message (peer, message);
264 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE:
265 GST_neighbours_keepalive (peer);
268 /* should be payload */
269 ret = process_payload (peer, message, ats, ats_count);
274 /* FIXME: this should not be needed, and not sure it's good to have it, but without
275 * this connections seem to go extra-slow */
276 GNUNET_ATS_address_update (GST_ats, &address, session, ats, ats_count);
279 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
280 "Allowing receive from peer %s to continue in %llu ms\n",
281 GNUNET_i2s (peer), (unsigned long long) ret.rel_value);
288 * Function that will be called for each address the transport
289 * is aware that it might be reachable under. Update our HELLO.
291 * @param cls name of the plugin (const char*)
292 * @param add_remove should the address added (YES) or removed (NO) from the
293 * set of valid addresses?
294 * @param addr one of the addresses of the host
295 * the specific address format depends on the transport
296 * @param addrlen length of the address
299 plugin_env_address_change_notification (void *cls, int add_remove,
300 const void *addr, size_t addrlen)
302 const char *plugin_name = cls;
303 struct GNUNET_HELLO_Address address;
305 address.peer = GST_my_identity;
306 address.transport_name = plugin_name;
307 address.address = addr;
308 address.address_length = addrlen;
309 GST_hello_modify_addresses (add_remove, &address);
314 * Function that will be called whenever the plugin internally
315 * cleans up a session pointer and hence the service needs to
316 * discard all of those sessions as well. Plugins that do not
317 * use sessions can simply omit calling this function and always
318 * use NULL wherever a session pointer is needed. This function
319 * should be called BEFORE a potential "TransmitContinuation"
320 * from the "TransmitFunction".
323 * @param peer which peer was the session for
324 * @param session which session is being destoyed
327 plugin_env_session_end (void *cls, const struct GNUNET_PeerIdentity *peer,
328 struct Session *session)
330 struct GNUNET_HELLO_Address address;
333 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Session %X to peer `%s' ended \n",
334 session, GNUNET_i2s (peer));
337 GNUNET_log_from (GNUNET_ERROR_TYPE_INFO | GNUNET_ERROR_TYPE_BULK,
339 "Telling ATS to destroy session %p from peer %s\n",
340 session, GNUNET_i2s (peer));
341 address.peer = *peer;
342 address.address = NULL;
343 address.address_length = 0;
344 address.transport_name = cls;
345 GNUNET_ATS_address_destroyed (GST_ats, &address, session);
346 GST_neighbours_session_terminated (peer, session);
351 * Function called by ATS to notify the callee that the
352 * assigned bandwidth or address for a given peer was changed. If the
353 * callback is called with address/bandwidth assignments of zero, the
354 * ATS disconnect function will still be called once the disconnect
358 * @param address address to use (for peer given in address)
359 * @param session session to use (if available)
360 * @param bandwidth_out assigned outbound bandwidth for the connection, 0 to disconnect from peer
361 * @param bandwidth_in assigned inbound bandwidth for the connection, 0 to disconnect from peer
364 ats_request_address_change (void *cls,
365 const struct GNUNET_HELLO_Address *address,
366 struct Session *session,
367 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
368 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
369 const struct GNUNET_ATS_Information *ats,
372 uint32_t bw_in = ntohl (bandwidth_in.value__);
373 uint32_t bw_out = ntohl (bandwidth_out.value__);
375 /* ATS tells me to disconnect from peer */
376 if ((bw_in == 0) && (bw_out == 0))
379 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
380 "ATS tells me to disconnect from peer `%s'\n",
381 GNUNET_i2s (&address->peer));
383 GST_neighbours_force_disconnect (&address->peer);
386 /* will never return GNUNET_YES since connection is to be established */
387 GST_neighbours_switch_to_address_3way (&address->peer,
388 address, session, ats,
389 ats_count, bandwidth_in,
395 * Function called to notify transport users that another
396 * peer connected to us.
399 * @param peer the peer that connected
400 * @param ats performance data
401 * @param ats_count number of entries in ats
404 neighbours_connect_notification (void *cls,
405 const struct GNUNET_PeerIdentity *peer,
406 const struct GNUNET_ATS_Information *ats,
410 sizeof (struct ConnectInfoMessage) +
411 ats_count * sizeof (struct GNUNET_ATS_Information);
413 struct ConnectInfoMessage *connect_msg = (struct ConnectInfoMessage *) buf;
414 struct GNUNET_ATS_Information *ap;
416 connect_msg->header.size = htons (sizeof (buf));
417 connect_msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
418 connect_msg->ats_count = htonl (ats_count);
419 connect_msg->id = *peer;
420 ap = (struct GNUNET_ATS_Information *) &connect_msg[1];
421 memcpy (ap, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
422 GST_clients_broadcast (&connect_msg->header, GNUNET_NO);
427 * Function called to notify transport users that another
428 * peer disconnected from us.
431 * @param peer the peer that disconnected
434 neighbours_disconnect_notification (void *cls,
435 const struct GNUNET_PeerIdentity *peer)
437 struct DisconnectInfoMessage disconnect_msg;
439 disconnect_msg.header.size = htons (sizeof (struct DisconnectInfoMessage));
440 disconnect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT);
441 disconnect_msg.reserved = htonl (0);
442 disconnect_msg.peer = *peer;
443 GST_clients_broadcast (&disconnect_msg.header, GNUNET_NO);
448 * Function called when the service shuts down. Unloads our plugins
449 * and cancels pending validations.
451 * @param cls closure, unused
452 * @param tc task context (unused)
455 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
457 GST_neighbours_stop ();
458 GST_validation_stop ();
459 GST_plugins_unload ();
461 GNUNET_ATS_scheduling_done (GST_ats);
464 GST_blacklist_stop ();
467 if (GST_peerinfo != NULL)
469 GNUNET_PEERINFO_disconnect (GST_peerinfo);
472 if (GST_stats != NULL)
474 GNUNET_STATISTICS_destroy (GST_stats, GNUNET_NO);
477 if (GST_my_private_key != NULL)
479 GNUNET_CRYPTO_rsa_key_free (GST_my_private_key);
480 GST_my_private_key = NULL;
486 * Initiate transport service.
489 * @param server the initialized server
490 * @param c configuration to use
493 run (void *cls, struct GNUNET_SERVER_Handle *server,
494 const struct GNUNET_CONFIGURATION_Handle *c)
501 GNUNET_CONFIGURATION_get_value_filename (c, "GNUNETD", "HOSTKEY",
504 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
506 ("Transport service is lacking key configuration settings. Exiting.\n"));
507 GNUNET_SCHEDULER_shutdown ();
510 GST_my_private_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
511 GNUNET_free (keyfile);
512 if (GST_my_private_key == NULL)
514 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
515 _("Transport service could not access hostkey. Exiting.\n"));
516 GNUNET_SCHEDULER_shutdown ();
519 GST_stats = GNUNET_STATISTICS_create ("transport", c);
520 GST_peerinfo = GNUNET_PEERINFO_connect (c);
521 GNUNET_CRYPTO_rsa_key_get_public (GST_my_private_key, &GST_my_public_key);
522 GNUNET_CRYPTO_hash (&GST_my_public_key, sizeof (GST_my_public_key),
523 &GST_my_identity.hashPubKey);
524 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
526 if (GST_peerinfo == NULL)
528 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
529 _("Could not access PEERINFO service. Exiting.\n"));
530 GNUNET_SCHEDULER_shutdown ();
534 /* start subsystems */
535 GST_hello_start (&process_hello_update, NULL);
536 GST_blacklist_start (server);
537 GST_plugins_load (&plugin_env_receive_callback,
538 &plugin_env_address_change_notification,
539 &plugin_env_session_end);
541 GNUNET_ATS_scheduling_init (GST_cfg, &ats_request_address_change, NULL);
542 GST_neighbours_start (NULL, &neighbours_connect_notification,
543 &neighbours_disconnect_notification);
544 GST_clients_start (server);
545 GST_validation_start ();
550 * The main function for the transport service.
552 * @param argc number of arguments from the command line
553 * @param argv command line arguments
554 * @return 0 ok, 1 on error
557 main (int argc, char *const *argv)
560 GNUNET_SERVICE_run (argc, argv, "transport",
561 GNUNET_SERVICE_OPTION_NONE, &run, NULL)) ? 0 : 1;
564 /* end of file gnunet-service-transport-new.c */