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-new.c
  23  * @brief
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "gnunet_util_lib.h"
  28 #include "gnunet_statistics_service.h"
  29 #include "gnunet_transport_service.h"
  30 #include "gnunet_peerinfo_service.h"
  31 #include "gnunet_ats_service.h"
  32 #include "gnunet-service-transport.h"
  33 #include "gnunet-service-transport_blacklist.h"
  34 #include "gnunet-service-transport_clients.h"
  35 #include "gnunet-service-transport_hello.h"
  36 #include "gnunet-service-transport_neighbours.h"
  37 #include "gnunet-service-transport_plugins.h"
  38 #include "gnunet-service-transport_validation.h"
  39 #include "transport.h"
  40
  41 /* globals */
  42
  43 /**
  44  * Statistics handle.
  45  */
  46 struct GNUNET_STATISTICS_Handle *GST_stats;
  47
  48 /**
  49  * Configuration handle.
  50  */
  51 const struct GNUNET_CONFIGURATION_Handle *GST_cfg;
  52
  53 /**
  54  * Configuration handle.
  55  */
  56 struct GNUNET_PeerIdentity GST_my_identity;
  57
  58 /**
  59  * Handle to peerinfo service.
  60  */
  61 struct GNUNET_PEERINFO_Handle *GST_peerinfo;
  62
  63 /**
  64  * Our public key.
  65  */
  66 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded GST_my_public_key;
  67
  68 /**
  69  * Our private key.
  70  */
  71 struct GNUNET_CRYPTO_RsaPrivateKey *GST_my_private_key;
  72
  73 /**
  74  * ATS handle.
  75  */
  76 struct GNUNET_ATS_SchedulingHandle *GST_ats;
  77
  78
  79 /**
  80  * Transmit our HELLO message to the given (connected) neighbour.
  81  *
  82  * @param cls the 'HELLO' message
  83  * @param target a connected neighbour
  84  * @param ats performance information (unused)
  85  * @param ats_count number of records in ats (unused)
  86  * @param transport plugin
  87  * @param addr address
  88  * @param addrlen address length
  89  */
  90 static void
  91 transmit_our_hello (void *cls, const struct GNUNET_PeerIdentity *target,
  92                     const struct GNUNET_ATS_Information *ats,
  93                     uint32_t ats_count,
  94                     const char * transport,
  95                     const void * addr,
  96                     size_t addrlen)
  97 {
  98   const struct GNUNET_MessageHeader *hello = cls;
  99
 100   GST_neighbours_send (target, (const char *) hello, ntohs (hello->size),
 101                        GNUNET_CONSTANTS_HELLO_ADDRESS_EXPIRATION, NULL, NULL);
 102 }
 103
 104
 105 /**
 106  * My HELLO has changed. Tell everyone who should know.
 107  *
 108  * @param cls unused
 109  * @param hello new HELLO
 110  */
 111 static void
 112 process_hello_update (void *cls, const struct GNUNET_MessageHeader *hello)
 113 {
 114   GST_clients_broadcast (hello, GNUNET_NO);
 115   GST_neighbours_iterate (&transmit_our_hello, (void *) hello);
 116 }
 117
 118
 119
 120 /**
 121  * We received some payload.  Prepare to pass it on to our clients.
 122  *
 123  * @param peer (claimed) identity of the other peer
 124  * @param message the message, NULL if we only care about
 125  *                learning about the delay until we should receive again -- FIXME!
 126  * @param ats performance information
 127  * @param ats_count number of records in ats
 128  * @return how long the plugin should wait until receiving more data
 129  */
 130 static struct GNUNET_TIME_Relative
 131 process_payload (const struct GNUNET_PeerIdentity *peer,
 132                  const struct GNUNET_MessageHeader *message,
 133                  const struct GNUNET_ATS_Information *ats,
 134                  uint32_t ats_count)
 135 {
 136   struct GNUNET_TIME_Relative ret;
 137   int do_forward;
 138   struct InboundMessage *im;
 139   size_t msg_size = ntohs (message->size);
 140   size_t size = sizeof (struct InboundMessage) + msg_size + sizeof (struct GNUNET_ATS_Information) * ats_count;
 141   char buf[size];
 142   struct GNUNET_ATS_Information *ap;
 143
 144   ret = GNUNET_TIME_UNIT_ZERO;
 145   do_forward = GNUNET_SYSERR;
 146   ret =
 147     GST_neighbours_calculate_receive_delay (peer,
 148                                             (message ==
 149                                              NULL) ? 0 :
 150                                             msg_size,
 151                                             &do_forward);
 152
 153   if (!GST_neighbours_test_connected (peer))
 154   {
 155
 156     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Discarded %u bytes type %u payload from peer `%s'\n",
 157                       msg_size,
 158                       ntohs (message->type),
 159                       GNUNET_i2s (peer));
 160
 161     GNUNET_STATISTICS_update (GST_stats,
 162                               gettext_noop ("# bytes payload discarded due to not connected peer "),
 163                               msg_size,
 164                               GNUNET_NO);
 165     return ret;
 166   }
 167
 168   if (do_forward != GNUNET_YES)
 169     return ret;
 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);
 174   im->peer = *peer;
 175   ap = (struct GNUNET_ATS_Information*) &im[1];
 176   memcpy (ap, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
 177   memcpy (&ap[ats_count], message, ntohs (message->size));
 178
 179   GST_clients_broadcast (&im->header, GNUNET_YES);
 180
 181   return ret;
 182 }
 183
 184
 185 /**
 186  * Function called by the transport for each received message.
 187  * This function should also be called with "NULL" for the
 188  * message to signal that the other peer disconnected.
 189  *
 190  * @param cls closure, const char* with the name of the plugin we received the message from
 191  * @param peer (claimed) identity of the other peer
 192  * @param message the message, NULL if we only care about
 193  *                learning about the delay until we should receive again -- FIXME!
 194  * @param ats performance information
 195  * @param ats_count number of records in ats
 196  * @param session identifier used for this session (NULL for plugins
 197  *                that do not offer bi-directional communication to the sender
 198  *                using the same "connection")
 199  * @param sender_address binary address of the sender (if we established the
 200  *                connection or are otherwise sure of it; should be NULL
 201  *                for inbound TCP/UDP connections since it it not clear
 202  *                that we could establish ourselves a connection to that
 203  *                IP address and get the same system)
 204  * @param sender_address_len number of bytes in sender_address
 205  * @return how long the plugin should wait until receiving more data
 206  *         (plugins that do not support this, can ignore the return value)
 207  */
 208 static struct GNUNET_TIME_Relative
 209 plugin_env_receive_callback (void *cls, const struct GNUNET_PeerIdentity *peer,
 210                              const struct GNUNET_MessageHeader *message,
 211                              const struct GNUNET_ATS_Information *ats,
 212                              uint32_t ats_count, struct Session *session,
 213                              const char *sender_address,
 214                              uint16_t sender_address_len)
 215 {
 216   const char *plugin_name = cls;
 217   struct GNUNET_TIME_Relative ret;
 218   uint16_t type;
 219
 220   ret = GNUNET_TIME_UNIT_ZERO;
 221   if (NULL == message)
 222     goto end;
 223   type = ntohs (message->type);
 224 #if DEBUG_TRANSPORT
 225
 226   GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Received Message with type %u\n", type);
 227 #endif
 228
 229   switch (type)
 230   {
 231   case GNUNET_MESSAGE_TYPE_HELLO:
 232     GST_validation_handle_hello (message);
 233     return ret;
 234   case GNUNET_MESSAGE_TYPE_TRANSPORT_PING:
 235 #if DEBUG_TRANSPORT
 236     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
 237                 "Processing `%s' from `%s'\n", "PING",
 238                 (sender_address != NULL) ? GST_plugins_a2s (plugin_name,
 239                                                             sender_address,
 240                                                             sender_address_len)
 241                 : "<inbound>");
 242 #endif
 243     GST_validation_handle_ping (peer, message, plugin_name, session,
 244                                 sender_address, sender_address_len);
 245     break;
 246   case GNUNET_MESSAGE_TYPE_TRANSPORT_PONG:
 247 #if DEBUG_TRANSPORT
 248     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
 249                 "Processing `%s' from `%s'\n", "PONG",
 250                 (sender_address != NULL) ? GST_plugins_a2s (plugin_name,
 251                                                             sender_address,
 252                                                             sender_address_len)
 253                 : "<inbound>");
 254 #endif
 255     GST_validation_handle_pong (peer, message);
 256     break;
 257   case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT:
 258     GST_neighbours_handle_connect (message,
 259                                    peer,
 260                                    plugin_name, sender_address, sender_address_len,
 261                                    session, ats, ats_count);
 262     break;
 263   case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT_ACK:
 264     GST_neighbours_handle_connect_ack (message,
 265                                    peer,
 266                                    plugin_name, sender_address, sender_address_len,
 267                                    session, ats, ats_count);
 268     break;
 269   case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_ACK:
 270     GST_neighbours_handle_ack (message,
 271                                    peer,
 272                                    plugin_name, sender_address, sender_address_len,
 273                                    session, ats, ats_count);
 274     break;
 275   case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT:
 276     GST_neighbours_handle_disconnect_message (peer, message);
 277     break;
 278   case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE:
 279     GST_neighbours_keepalive (peer);
 280     break;
 281   default:
 282     /* should be payload */
 283     ret = process_payload (peer,
 284                            message,
 285                            ats, ats_count);
 286     break;
 287   }
 288  end:
 289 #if 1
 290   /* FIXME: this should not be needed, and not sure it's good to have it, but without
 291      this connections seem to go extra-slow */
 292   GNUNET_ATS_address_update (GST_ats, peer,
 293                              plugin_name, sender_address, sender_address_len,
 294                              session,
 295                              ats, ats_count);
 296 #endif
 297 #if DEBUG_TRANSPORT
 298   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 299               "Allowing receive from peer %s to continue in %llu ms\n",
 300               GNUNET_i2s (peer),
 301               (unsigned long long) ret.rel_value);
 302 #endif
 303   return ret;
 304 }
 305
 306
 307 /**
 308  * Function that will be called for each address the transport
 309  * is aware that it might be reachable under.  Update our HELLO.
 310  *
 311  * @param cls name of the plugin (const char*)
 312  * @param add_remove should the address added (YES) or removed (NO) from the
 313  *                   set of valid addresses?
 314  * @param addr one of the addresses of the host
 315  *        the specific address format depends on the transport
 316  * @param addrlen length of the address
 317  */
 318 static void
 319 plugin_env_address_change_notification (void *cls, int add_remove,
 320                                         const void *addr, size_t addrlen)
 321 {
 322   const char *plugin_name = cls;
 323
 324   GST_hello_modify_addresses (add_remove, plugin_name, addr, addrlen);
 325 }
 326
 327
 328 /**
 329  * Function that will be called whenever the plugin internally
 330  * cleans up a session pointer and hence the service needs to
 331  * discard all of those sessions as well.  Plugins that do not
 332  * use sessions can simply omit calling this function and always
 333  * use NULL wherever a session pointer is needed.  This function
 334  * should be called BEFORE a potential "TransmitContinuation"
 335  * from the "TransmitFunction".
 336  *
 337  * @param cls closure
 338  * @param peer which peer was the session for
 339  * @param session which session is being destoyed
 340  */
 341 static void
 342 plugin_env_session_end (void *cls, const struct GNUNET_PeerIdentity *peer,
 343                         struct Session *session)
 344 {
 345 #if DEBUG_TRANSPORT
 346   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 347               "Session %X to peer `%s' ended \n",
 348               session, GNUNET_i2s (peer));
 349 #endif
 350   if (NULL != session)
 351     GNUNET_log_from (GNUNET_ERROR_TYPE_INFO  | GNUNET_ERROR_TYPE_BULK,
 352                      "transport-ats",
 353                      "Telling ATS to destroy session %p from peer %s\n",
 354                      session,
 355                      GNUNET_i2s (peer));
 356   GNUNET_ATS_address_destroyed (GST_ats, peer, NULL, NULL, 0, session);
 357   GST_neighbours_session_terminated (peer, session);
 358 }
 359
 360
 361 /**
 362  * Function called by ATS to notify the callee that the
 363  * assigned bandwidth or address for a given peer was changed.  If the
 364  * callback is called with address/bandwidth assignments of zero, the
 365  * ATS disconnect function will still be called once the disconnect
 366  * actually happened.
 367  *
 368  * @param cls closure
 369  * @param peer identity of the peer
 370  * @param plugin_name name of the transport plugin, NULL to disconnect
 371  * @param session session to use (if available)
 372  * @param plugin_addr address to use (if available)
 373  * @param plugin_addr_len number of bytes in addr
 374  * @param bandwidth_out assigned outbound bandwidth for the connection, 0 to disconnect from peer
 375  * @param bandwidth_in assigned inbound bandwidth for the connection, 0 to disconnect from peer
 376  */
 377 static void
 378 ats_request_address_change (void *cls, const struct GNUNET_PeerIdentity *peer,
 379                             const char *plugin_name,
 380                             const void *plugin_addr, size_t plugin_addr_len,
 381                             struct Session *session,
 382                             struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
 383                             struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
 384                             const struct GNUNET_ATS_Information * ats,
 385                             uint32_t ats_count)
 386 {
 387   uint32_t bw_in = ntohl (bandwidth_in.value__);
 388   uint32_t bw_out = ntohl (bandwidth_out.value__);
 389
 390   /* ATS tells me to disconnect from peer*/
 391   if ((bw_in == 0) && (bw_out == 0))
 392   {
 393 #if DEBUG_TRANSPORT
 394     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 395                 "ATS tells me to disconnect from peer `%s'\n",
 396                 GNUNET_i2s (peer));
 397 #endif
 398     GST_neighbours_force_disconnect(peer);
 399     return;
 400   }
 401   /* will never return GNUNET_YES since connection is to be established */
 402   GST_neighbours_switch_to_address_3way (peer, plugin_name, plugin_addr,
 403                                     plugin_addr_len, session, ats, ats_count,
 404                                     bandwidth_in, bandwidth_out);
 405 }
 406
 407
 408 /**
 409  * Function called to notify transport users that another
 410  * peer connected to us.
 411  *
 412  * @param cls closure
 413  * @param peer the peer that connected
 414  * @param ats performance data
 415  * @param ats_count number of entries in ats
 416  */
 417 static void
 418 neighbours_connect_notification (void *cls,
 419                                  const struct GNUNET_PeerIdentity *peer,
 420                                  const struct GNUNET_ATS_Information
 421                                  *ats, uint32_t ats_count)
 422 {
 423   size_t len = sizeof (struct ConnectInfoMessage) +
 424       ats_count * sizeof (struct GNUNET_ATS_Information);
 425   char buf[len];
 426   struct ConnectInfoMessage *connect_msg = (struct ConnectInfoMessage *) buf;
 427   struct GNUNET_ATS_Information *ap;
 428
 429   connect_msg->header.size = htons (sizeof (buf));
 430   connect_msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
 431   connect_msg->ats_count = htonl (ats_count);
 432   connect_msg->id = *peer;
 433   ap = (struct GNUNET_ATS_Information *) &connect_msg[1];
 434   memcpy (ap, ats,
 435           ats_count * sizeof (struct GNUNET_ATS_Information));
 436   GST_clients_broadcast (&connect_msg->header, GNUNET_NO);
 437 }
 438
 439
 440 /**
 441  * Function called to notify transport users that another
 442  * peer disconnected from us.
 443  *
 444  * @param cls closure
 445  * @param peer the peer that disconnected
 446  */
 447 static void
 448 neighbours_disconnect_notification (void *cls,
 449                                     const struct GNUNET_PeerIdentity *peer)
 450 {
 451   struct DisconnectInfoMessage disconnect_msg;
 452
 453   disconnect_msg.header.size = htons (sizeof (struct DisconnectInfoMessage));
 454   disconnect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT);
 455   disconnect_msg.reserved = htonl (0);
 456   disconnect_msg.peer = *peer;
 457   GST_clients_broadcast (&disconnect_msg.header, GNUNET_NO);
 458 }
 459
 460
 461 /**
 462  * Function called when the service shuts down.  Unloads our plugins
 463  * and cancels pending validations.
 464  *
 465  * @param cls closure, unused
 466  * @param tc task context (unused)
 467  */
 468 static void
 469 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 470 {
 471   GST_validation_stop ();
 472   GST_plugins_unload ();
 473   GST_neighbours_stop ();
 474   GNUNET_ATS_scheduling_done (GST_ats);
 475   GST_ats = NULL;
 476   GST_clients_stop ();
 477   GST_blacklist_stop ();
 478   GST_hello_stop ();
 479
 480   if (GST_peerinfo != NULL)
 481   {
 482     GNUNET_PEERINFO_disconnect (GST_peerinfo);
 483     GST_peerinfo = NULL;
 484   }
 485   if (GST_stats != NULL)
 486   {
 487     GNUNET_STATISTICS_destroy (GST_stats, GNUNET_NO);
 488     GST_stats = NULL;
 489   }
 490   if (GST_my_private_key != NULL)
 491   {
 492     GNUNET_CRYPTO_rsa_key_free (GST_my_private_key);
 493     GST_my_private_key = NULL;
 494   }
 495 }
 496
 497
 498 /**
 499  * Initiate transport service.
 500  *
 501  * @param cls closure
 502  * @param server the initialized server
 503  * @param c configuration to use
 504  */
 505 static void
 506 run (void *cls, struct GNUNET_SERVER_Handle *server,
 507      const struct GNUNET_CONFIGURATION_Handle *c)
 508 {
 509   char *keyfile;
 510
 511   /* setup globals */
 512   GST_cfg = c;
 513   if (GNUNET_OK !=
 514       GNUNET_CONFIGURATION_get_value_filename (c, "GNUNETD", "HOSTKEY",
 515                                                &keyfile))
 516   {
 517     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 518                 _
 519                 ("Transport service is lacking key configuration settings.  Exiting.\n"));
 520     GNUNET_SCHEDULER_shutdown ();
 521     return;
 522   }
 523   GST_my_private_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
 524   GNUNET_free (keyfile);
 525   if (GST_my_private_key == NULL)
 526   {
 527     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 528                 _("Transport service could not access hostkey.  Exiting.\n"));
 529     GNUNET_SCHEDULER_shutdown ();
 530     return;
 531   }
 532   GST_stats = GNUNET_STATISTICS_create ("transport", c);
 533   GST_peerinfo = GNUNET_PEERINFO_connect (c);
 534   GNUNET_CRYPTO_rsa_key_get_public (GST_my_private_key, &GST_my_public_key);
 535   GNUNET_CRYPTO_hash (&GST_my_public_key, sizeof (GST_my_public_key),
 536                       &GST_my_identity.hashPubKey);
 537   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
 538                                 NULL);
 539   if (GST_peerinfo == NULL)
 540   {
 541     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 542                 _("Could not access PEERINFO service.  Exiting.\n"));
 543     GNUNET_SCHEDULER_shutdown ();
 544     return;
 545   }
 546
 547   /* start subsystems */
 548   GST_hello_start (&process_hello_update, NULL);
 549   GST_blacklist_start (server);
 550   GST_plugins_load (&plugin_env_receive_callback,
 551                     &plugin_env_address_change_notification,
 552                     &plugin_env_session_end);
 553   GST_ats = GNUNET_ATS_scheduling_init (GST_cfg, &ats_request_address_change, NULL);
 554   GST_neighbours_start (NULL, &neighbours_connect_notification,
 555                         &neighbours_disconnect_notification);
 556   GST_clients_start (server);
 557   GST_validation_start ();
 558 }
 559
 560
 561 /**
 562  * The main function for the transport service.
 563  *
 564  * @param argc number of arguments from the command line
 565  * @param argv command line arguments
 566  * @return 0 ok, 1 on error
 567  */
 568 int
 569 main (int argc, char *const *argv)
 570 {
 571   return (GNUNET_OK ==
 572           GNUNET_SERVICE_run (argc, argv, "transport",
 573                               GNUNET_SERVICE_OPTION_NONE, &run, NULL)) ? 0 : 1;
 574 }
 575
 576 /* end of file gnunet-service-transport-new.c */