removing ats functions from plugins, instead provide callback function
[oweals/gnunet.git] / src / transport / gnunet-service-transport.c
1 /*
2      This file is part of GNUnet.
3      (C) 2010,2011 Christian Grothoff (and other contributing authors)
4
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.
9
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.
14
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.
19 */
20
21 /**
22  * @file transport/gnunet-service-transport.c
23  * @brief
24  * @author Christian Grothoff
25  */
26 #include "platform.h"
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"
41
42 /* globals */
43
44 /**
45  * Statistics handle.
46  */
47 struct GNUNET_STATISTICS_Handle *GST_stats;
48
49 /**
50  * Configuration handle.
51  */
52 const struct GNUNET_CONFIGURATION_Handle *GST_cfg;
53
54 /**
55  * Configuration handle.
56  */
57 struct GNUNET_PeerIdentity GST_my_identity;
58
59 /**
60  * Handle to peerinfo service.
61  */
62 struct GNUNET_PEERINFO_Handle *GST_peerinfo;
63
64 /**
65  * Our public key.
66  */
67 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded GST_my_public_key;
68
69 /**
70  * Our private key.
71  */
72 struct GNUNET_CRYPTO_RsaPrivateKey *GST_my_private_key;
73
74 /**
75  * ATS handle.
76  */
77 struct GNUNET_ATS_SchedulingHandle *GST_ats;
78
79
80 /**
81  * Transmit our HELLO message to the given (connected) neighbour.
82  *
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
88  */
89 static void
90 transmit_our_hello (void *cls, const struct GNUNET_PeerIdentity *target,
91                     const struct GNUNET_ATS_Information *ats,
92                     uint32_t ats_count,
93                     const struct GNUNET_HELLO_Address *address)
94 {
95   const struct GNUNET_MessageHeader *hello = cls;
96
97   GST_neighbours_send (target, (const char *) hello, ntohs (hello->size),
98                        GNUNET_CONSTANTS_HELLO_ADDRESS_EXPIRATION, NULL, NULL);
99 }
100
101
102 /**
103  * My HELLO has changed. Tell everyone who should know.
104  *
105  * @param cls unused
106  * @param hello new HELLO
107  */
108 static void
109 process_hello_update (void *cls, const struct GNUNET_MessageHeader *hello)
110 {
111   GST_clients_broadcast (hello, GNUNET_NO);
112   GST_neighbours_iterate (&transmit_our_hello, (void *) hello);
113 }
114
115
116
117 /**
118  * We received some payload.  Prepare to pass it on to our clients.
119  *
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
127  */
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)
134 {
135   struct GNUNET_TIME_Relative ret;
136   int do_forward;
137   struct InboundMessage *im;
138   size_t msg_size = ntohs (message->size);
139   size_t size =
140       sizeof (struct InboundMessage) + msg_size +
141       sizeof (struct GNUNET_ATS_Information) * (ats_count + 1);
142   char buf[size];
143   struct GNUNET_ATS_Information *ap;
144
145   ret = GNUNET_TIME_UNIT_ZERO;
146   do_forward = GNUNET_SYSERR;
147   ret = GST_neighbours_calculate_receive_delay (peer, msg_size, &do_forward);
148
149   if (!GST_neighbours_test_connected (peer))
150   {
151
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));
155
156     GNUNET_STATISTICS_update (GST_stats,
157                               gettext_noop
158                               ("# bytes payload discarded due to not connected peer "),
159                               msg_size, GNUNET_NO);
160     return ret;
161   }
162
163   if (do_forward != GNUNET_YES)
164     return ret;
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);
169   im->peer = *peer;
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));
176
177   GNUNET_ATS_address_update (GST_ats, address, session, ap, ats_count + 1);
178   GST_clients_broadcast (&im->header, GNUNET_YES);
179
180   return ret;
181 }
182
183
184 /**
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.
188  *
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)
206  */
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)
214 {
215   const char *plugin_name = cls;
216   struct GNUNET_TIME_Relative ret;
217   struct GNUNET_HELLO_Address address;
218   uint16_t type;
219
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;
225   if (NULL == message)
226     goto end;
227   type = ntohs (message->type);
228 #if DEBUG_TRANSPORT
229
230   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received Message with type %u\n", type);
231 #endif
232
233   switch (type)
234   {
235   case GNUNET_MESSAGE_TYPE_HELLO:
236     GST_validation_handle_hello (message);
237     return ret;
238   case GNUNET_MESSAGE_TYPE_TRANSPORT_PING:
239 #if DEBUG_TRANSPORT
240     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
241                 "Processing `%s' from `%s'\n", "PING",
242                 (sender_address !=
243                  NULL) ? GST_plugins_a2s (&address) : "<inbound>");
244 #endif
245     GST_validation_handle_ping (peer, message, &address, session);
246     break;
247   case GNUNET_MESSAGE_TYPE_TRANSPORT_PONG:
248 #if DEBUG_TRANSPORT
249     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
250                 "Processing `%s' from `%s'\n", "PONG",
251                 (sender_address !=
252                  NULL) ? GST_plugins_a2s (&address) : "<inbound>");
253 #endif
254     GST_validation_handle_pong (peer, message);
255     break;
256   case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT:
257     GST_neighbours_handle_connect (message, peer, &address, session, ats,
258                                    ats_count);
259     break;
260   case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT_ACK:
261     GST_neighbours_handle_connect_ack (message, peer, &address, session, ats,
262                                        ats_count);
263     break;
264   case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_ACK:
265     GST_neighbours_handle_ack (message, peer, &address, session, ats,
266                                ats_count);
267     break;
268   case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT:
269     GST_neighbours_handle_disconnect_message (peer, message);
270     break;
271   case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE:
272     GST_neighbours_keepalive (peer);
273     break;
274   case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE_RESPONSE:
275     GST_neighbours_keepalive_response (peer, ats, ats_count);
276     break;
277   default:
278     /* should be payload */
279     ret = process_payload (peer, &address, session, message, ats, ats_count);
280     break;
281   }
282 end:
283 #if 1
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);
287 #endif
288 #if DEBUG_TRANSPORT
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);
292 #endif
293   return ret;
294 }
295
296
297 /**
298  * Function that will be called for each address the transport
299  * is aware that it might be reachable under.  Update our HELLO.
300  *
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
307  */
308 static void
309 plugin_env_address_change_notification (void *cls, int add_remove,
310                                         const void *addr, size_t addrlen)
311 {
312   const char *plugin_name = cls;
313   struct GNUNET_HELLO_Address address;
314
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);
320 }
321
322
323 /**
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".
331  *
332  * @param cls closure
333  * @param peer which peer was the session for
334  * @param session which session is being destoyed
335  */
336 static void
337 plugin_env_session_end (void *cls, const struct GNUNET_PeerIdentity *peer,
338                         struct Session *session)
339 {
340   const char *transport_name = cls;
341   struct GNUNET_HELLO_Address address;
342
343   GNUNET_assert (strlen (transport_name) > 0);
344 #if DEBUG_TRANSPORT
345   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Session %X to peer `%s' ended \n",
346               session, GNUNET_i2s (peer));
347 #endif
348   if (NULL != session)
349     GNUNET_log_from (GNUNET_ERROR_TYPE_INFO | GNUNET_ERROR_TYPE_BULK,
350                      "transport-ats",
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);
359 }
360
361
362 /**
363  * Function that will be called to figure if an address is an loopback,
364  * LAN, WAN etc. address
365  *
366  * @param cls closure
367  * @param addr binary address
368  * @param addrlen length of the address
369  * @return ATS Information containing the network type
370  */
371 static const struct GNUNET_ATS_Information
372 plugin_env_address_to_type (void *cls,
373                             const struct sockaddr *addr,
374                             size_t addrlen)
375 {
376   struct GNUNET_ATS_Information ats;
377   ats.type = htonl (GNUNET_ATS_NETWORK_TYPE);
378   ats.value = htonl (GNUNET_ATS_NET_UNSPECIFIED);
379   if (GST_ats == NULL)
380   {
381     GNUNET_break (0);
382     return ats;
383   }
384   if ((addrlen != sizeof (struct sockaddr_in)) && (addrlen != sizeof (struct sockaddr_in6)))
385   {
386     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Malformed address with length %u `%s'\n",
387                 addrlen,
388                 GNUNET_a2s(addr, addrlen));
389     GNUNET_break (0);
390     return ats;
391   }
392   return GNUNET_ATS_address_get_type(GST_ats, addr, addrlen);
393 }
394
395
396 /**
397  * Function called by ATS to notify the callee that the
398  * assigned bandwidth or address for a given peer was changed.  If the
399  * callback is called with address/bandwidth assignments of zero, the
400  * ATS disconnect function will still be called once the disconnect
401  * actually happened.
402  *
403  * @param cls closure
404  * @param address address to use (for peer given in address)
405  * @param session session to use (if available)
406  * @param bandwidth_out assigned outbound bandwidth for the connection, 0 to disconnect from peer
407  * @param bandwidth_in assigned inbound bandwidth for the connection, 0 to disconnect from peer
408  * @param ats ATS information
409  * @param number of ATS elements
410  */
411 static void
412 ats_request_address_change (void *cls,
413                             const struct GNUNET_HELLO_Address *address,
414                             struct Session *session,
415                             struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
416                             struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
417                             const struct GNUNET_ATS_Information *ats,
418                             uint32_t ats_count)
419 {
420   uint32_t bw_in = ntohl (bandwidth_in.value__);
421   uint32_t bw_out = ntohl (bandwidth_out.value__);
422
423   /* ATS tells me to disconnect from peer */
424   if ((bw_in == 0) && (bw_out == 0))
425   {
426 #if DEBUG_TRANSPORT
427     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
428                 "ATS tells me to disconnect from peer `%s'\n",
429                 GNUNET_i2s (&address->peer));
430 #endif
431     GST_neighbours_force_disconnect (&address->peer);
432     return;
433   }
434   /* will never return GNUNET_YES since connection is to be established */
435   GST_neighbours_switch_to_address_3way (&address->peer, address, session, ats,
436                                          ats_count, bandwidth_in,
437                                          bandwidth_out);
438 }
439
440
441 /**
442  * Function called to notify transport users that another
443  * peer connected to us.
444  *
445  * @param cls closure
446  * @param peer the peer that connected
447  * @param ats performance data
448  * @param ats_count number of entries in ats
449  */
450 static void
451 neighbours_connect_notification (void *cls,
452                                  const struct GNUNET_PeerIdentity *peer,
453                                  const struct GNUNET_ATS_Information *ats,
454                                  uint32_t ats_count)
455 {
456   size_t len =
457       sizeof (struct ConnectInfoMessage) +
458       ats_count * sizeof (struct GNUNET_ATS_Information);
459   char buf[len];
460   struct ConnectInfoMessage *connect_msg = (struct ConnectInfoMessage *) buf;
461   struct GNUNET_ATS_Information *ap;
462
463   connect_msg->header.size = htons (sizeof (buf));
464   connect_msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
465   connect_msg->ats_count = htonl (ats_count);
466   connect_msg->id = *peer;
467   ap = (struct GNUNET_ATS_Information *) &connect_msg[1];
468   memcpy (ap, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
469   GST_clients_broadcast (&connect_msg->header, GNUNET_NO);
470 }
471
472
473 /**
474  * Function called to notify transport users that another
475  * peer disconnected from us.
476  *
477  * @param cls closure
478  * @param peer the peer that disconnected
479  */
480 static void
481 neighbours_disconnect_notification (void *cls,
482                                     const struct GNUNET_PeerIdentity *peer)
483 {
484   struct DisconnectInfoMessage disconnect_msg;
485
486   disconnect_msg.header.size = htons (sizeof (struct DisconnectInfoMessage));
487   disconnect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT);
488   disconnect_msg.reserved = htonl (0);
489   disconnect_msg.peer = *peer;
490   GST_clients_broadcast (&disconnect_msg.header, GNUNET_NO);
491 }
492
493
494 /**
495  * Function called when the service shuts down.  Unloads our plugins
496  * and cancels pending validations.
497  *
498  * @param cls closure, unused
499  * @param tc task context (unused)
500  */
501 static void
502 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
503 {
504   GST_neighbours_stop ();
505   GST_validation_stop ();
506   GST_plugins_unload ();
507
508   GNUNET_ATS_scheduling_done (GST_ats);
509   GST_ats = NULL;
510   GST_clients_stop ();
511   GST_blacklist_stop ();
512   GST_hello_stop ();
513
514   if (GST_peerinfo != NULL)
515   {
516     GNUNET_PEERINFO_disconnect (GST_peerinfo);
517     GST_peerinfo = NULL;
518   }
519   if (GST_stats != NULL)
520   {
521     GNUNET_STATISTICS_destroy (GST_stats, GNUNET_NO);
522     GST_stats = NULL;
523   }
524   if (GST_my_private_key != NULL)
525   {
526     GNUNET_CRYPTO_rsa_key_free (GST_my_private_key);
527     GST_my_private_key = NULL;
528   }
529 }
530
531
532 /**
533  * Initiate transport service.
534  *
535  * @param cls closure
536  * @param server the initialized server
537  * @param c configuration to use
538  */
539 static void
540 run (void *cls, struct GNUNET_SERVER_Handle *server,
541      const struct GNUNET_CONFIGURATION_Handle *c)
542 {
543   char *keyfile;
544
545   /* setup globals */
546   GST_cfg = c;
547   if (GNUNET_OK !=
548       GNUNET_CONFIGURATION_get_value_filename (c, "GNUNETD", "HOSTKEY",
549                                                &keyfile))
550   {
551     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
552                 _
553                 ("Transport service is lacking key configuration settings.  Exiting.\n"));
554     GNUNET_SCHEDULER_shutdown ();
555     return;
556   }
557   GST_my_private_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
558   GNUNET_free (keyfile);
559   if (GST_my_private_key == NULL)
560   {
561     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
562                 _("Transport service could not access hostkey.  Exiting.\n"));
563     GNUNET_SCHEDULER_shutdown ();
564     return;
565   }
566   GST_stats = GNUNET_STATISTICS_create ("transport", c);
567   GST_peerinfo = GNUNET_PEERINFO_connect (c);
568   GNUNET_CRYPTO_rsa_key_get_public (GST_my_private_key, &GST_my_public_key);
569   GNUNET_CRYPTO_hash (&GST_my_public_key, sizeof (GST_my_public_key),
570                       &GST_my_identity.hashPubKey);
571   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
572                                 NULL);
573   if (GST_peerinfo == NULL)
574   {
575     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
576                 _("Could not access PEERINFO service.  Exiting.\n"));
577     GNUNET_SCHEDULER_shutdown ();
578     return;
579   }
580
581   /* start subsystems */
582   GST_hello_start (&process_hello_update, NULL);
583   GST_blacklist_start (server);
584   GST_ats =
585       GNUNET_ATS_scheduling_init (GST_cfg, &ats_request_address_change, NULL);
586   GST_plugins_load (&plugin_env_receive_callback,
587                     &plugin_env_address_change_notification,
588                     &plugin_env_session_end,
589                     &plugin_env_address_to_type);
590   GST_neighbours_start (NULL, &neighbours_connect_notification,
591                         &neighbours_disconnect_notification);
592   GST_clients_start (server);
593   GST_validation_start ();
594 }
595
596
597 /**
598  * The main function for the transport service.
599  *
600  * @param argc number of arguments from the command line
601  * @param argv command line arguments
602  * @return 0 ok, 1 on error
603  */
604 int
605 main (int argc, char *const *argv)
606 {
607   return (GNUNET_OK ==
608           GNUNET_SERVICE_run (argc, argv, "transport",
609                               GNUNET_SERVICE_OPTION_NONE, &run, NULL)) ? 0 : 1;
610 }
611
612 /* end of file gnunet-service-transport-new.c */