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  * Try to initiate a connection to the given peer if the blacklist
 121  * allowed it.
 122  *
 123  * @param cls closure (unused, NULL)
 124  * @param peer identity of peer that was tested
 125  * @param result GNUNET_OK if the connection is allowed,
 126  *               GNUNET_NO if not
 127  */
 128 static void
 129 try_connect_if_allowed (void *cls, const struct GNUNET_PeerIdentity *peer,
 130                         int result)
 131 {
 132   if (GNUNET_OK != result)
 133     return;                     /* not allowed */
 134   GST_neighbours_try_connect (peer);
 135 }
 136
 137
 138 /**
 139  * We received some payload.  Prepare to pass it on to our clients.
 140  *
 141  * @param peer (claimed) identity of the other peer
 142  * @param message the message, NULL if we only care about
 143  *                learning about the delay until we should receive again -- FIXME!
 144  * @param ats performance information
 145  * @param ats_count number of records in ats
 146  * @return how long the plugin should wait until receiving more data
 147  */
 148 static struct GNUNET_TIME_Relative
 149 process_payload (const struct GNUNET_PeerIdentity *peer,
 150                  const struct GNUNET_MessageHeader *message,
 151                  const struct GNUNET_ATS_Information *ats,
 152                  uint32_t ats_count)
 153 {
 154   struct GNUNET_TIME_Relative ret;
 155   int do_forward;
 156   struct InboundMessage *im;
 157   size_t size = sizeof (struct InboundMessage) + ntohs (message->size);
 158   char buf[size];
 159   memset (&buf, 0, size);
 160
 161   ret = GNUNET_TIME_UNIT_ZERO;
 162   do_forward = GNUNET_SYSERR;
 163   ret =
 164     GST_neighbours_calculate_receive_delay (peer,
 165                                             (message ==
 166                                              NULL) ? 0 :
 167                                             ntohs (message->size),
 168                                             &do_forward);
 169   im = (struct InboundMessage*) buf;
 170   im->header.size = htons (size);
 171   im->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_RECV);
 172   im->ats_count = htonl (0);
 173   memcpy (&(im->peer), peer, sizeof (struct GNUNET_PeerIdentity));
 174   memcpy (&im[1], message, ntohs (message->size));
 175
 176   switch (do_forward)
 177   {
 178   case GNUNET_YES:
 179     GST_clients_broadcast (&im->header, GNUNET_YES);
 180     break;
 181   case GNUNET_NO:
 182     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 183                 _("Discarded %u bytes of type %u from %s: quota violated or no neighbour record!\n"),
 184                 ntohs (message->size),
 185                 ntohs (message->type),
 186                 GNUNET_i2s (peer));
 187     break;
 188   case GNUNET_SYSERR:
 189     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 190                 _("Discarded %u bytes of type %u from %s: connection is down!\n"),
 191                 ntohs (message->size),
 192                 ntohs (message->type),
 193                 GNUNET_i2s (peer));
 194     /* FIXME: store until connection is up? This is virtually always a SETKEY and a PING... */
 195     break;
 196   default:
 197     GNUNET_break (0);
 198     break;
 199   }
 200   return ret;
 201 }
 202
 203
 204 /**
 205  * Function called by the transport for each received message.
 206  * This function should also be called with "NULL" for the
 207  * message to signal that the other peer disconnected.
 208  *
 209  * @param cls closure, const char* with the name of the plugin we received the message from
 210  * @param peer (claimed) identity of the other peer
 211  * @param message the message, NULL if we only care about
 212  *                learning about the delay until we should receive again -- FIXME!
 213  * @param ats performance information
 214  * @param ats_count number of records in ats
 215  * @param session identifier used for this session (NULL for plugins
 216  *                that do not offer bi-directional communication to the sender
 217  *                using the same "connection")
 218  * @param sender_address binary address of the sender (if we established the
 219  *                connection or are otherwise sure of it; should be NULL
 220  *                for inbound TCP/UDP connections since it it not clear
 221  *                that we could establish ourselves a connection to that
 222  *                IP address and get the same system)
 223  * @param sender_address_len number of bytes in sender_address
 224  * @return how long the plugin should wait until receiving more data
 225  *         (plugins that do not support this, can ignore the return value)
 226  */
 227 static struct GNUNET_TIME_Relative
 228 plugin_env_receive_callback (void *cls, const struct GNUNET_PeerIdentity *peer,
 229                              const struct GNUNET_MessageHeader *message,
 230                              const struct GNUNET_ATS_Information *ats,
 231                              uint32_t ats_count, struct Session *session,
 232                              const char *sender_address,
 233                              uint16_t sender_address_len)
 234 {
 235   const char *plugin_name = cls;
 236   struct GNUNET_TIME_Relative ret;
 237   uint16_t type;
 238
 239   ret = GNUNET_TIME_UNIT_ZERO;
 240   if (NULL == message)
 241     goto end;
 242   type = ntohs (message->type);
 243   switch (type)
 244   {
 245   case GNUNET_MESSAGE_TYPE_HELLO:
 246     GST_validation_handle_hello (message);
 247     return ret;
 248   case GNUNET_MESSAGE_TYPE_TRANSPORT_PING:
 249 #if DEBUG_TRANSPORT
 250     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
 251                 "Processing `%s' from `%s'\n", "PING",
 252                 (sender_address != NULL) ? GST_plugins_a2s (plugin_name,
 253                                                             sender_address,
 254                                                             sender_address_len)
 255                 : "<inbound>");
 256 #endif
 257     GST_validation_handle_ping (peer, message, plugin_name, session,
 258                                 sender_address, sender_address_len);
 259     break;
 260   case GNUNET_MESSAGE_TYPE_TRANSPORT_PONG:
 261 #if DEBUG_TRANSPORT
 262     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
 263                 "Processing `%s' from `%s'\n", "PONG",
 264                 (sender_address != NULL) ? GST_plugins_a2s (plugin_name,
 265                                                             sender_address,
 266                                                             sender_address_len)
 267                 : "<inbound>");
 268 #endif
 269     GST_validation_handle_pong (peer, message);
 270     break;
 271   case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT:
 272     GST_neighbours_handle_connect (message,
 273                                    peer,
 274                                    plugin_name, sender_address, sender_address_len,
 275                                    session, ats, ats_count);
 276     (void) GST_blacklist_test_allowed (peer, NULL, &try_connect_if_allowed,
 277                                        NULL);
 278     break;
 279   case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT:
 280     GST_neighbours_handle_disconnect_message (peer, message);
 281     break;
 282   case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE:
 283     GST_neighbours_keepalive (peer);
 284     break;
 285   default:
 286     /* should be payload */
 287     ret = process_payload (peer,
 288                            message,
 289                            ats, ats_count);
 290     break;
 291   }
 292  end:
 293 #if 1
 294   /* FIXME: this should not be needed, and not sure it's good to have it, but without
 295      this connections seem to go extra-slow */
 296   GNUNET_ATS_address_update (GST_ats, peer,
 297                              plugin_name, sender_address, sender_address_len,
 298                              session,
 299                              ats, ats_count);
 300 #endif
 301 #if DEBUG_TRANSPORT
 302   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 303               "Allowing receive from peer %s to continue in %llu ms\n",
 304               GNUNET_i2s (peer),
 305               (unsigned long long) ret.rel_value);
 306 #endif
 307   return ret;
 308 }
 309
 310
 311 /**
 312  * Function that will be called for each address the transport
 313  * is aware that it might be reachable under.  Update our HELLO.
 314  *
 315  * @param cls name of the plugin (const char*)
 316  * @param add_remove should the address added (YES) or removed (NO) from the
 317  *                   set of valid addresses?
 318  * @param addr one of the addresses of the host
 319  *        the specific address format depends on the transport
 320  * @param addrlen length of the address
 321  */
 322 static void
 323 plugin_env_address_change_notification (void *cls, int add_remove,
 324                                         const void *addr, size_t addrlen)
 325 {
 326   const char *plugin_name = cls;
 327
 328   GST_hello_modify_addresses (add_remove, plugin_name, addr, addrlen);
 329 }
 330
 331
 332 /**
 333  * Function that will be called whenever the plugin internally
 334  * cleans up a session pointer and hence the service needs to
 335  * discard all of those sessions as well.  Plugins that do not
 336  * use sessions can simply omit calling this function and always
 337  * use NULL wherever a session pointer is needed.  This function
 338  * should be called BEFORE a potential "TransmitContinuation"
 339  * from the "TransmitFunction".
 340  *
 341  * @param cls closure
 342  * @param peer which peer was the session for
 343  * @param session which session is being destoyed
 344  */
 345 static void
 346 plugin_env_session_end (void *cls, const struct GNUNET_PeerIdentity *peer,
 347                         struct Session *session)
 348 {
 349 #if DEBUG_TRANSPORT
 350   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 351               "Session %X to peer `%s' ended \n",
 352               session, GNUNET_i2s (peer));
 353 #endif
 354   if (NULL != session)
 355     GNUNET_log_from (GNUNET_ERROR_TYPE_INFO  | GNUNET_ERROR_TYPE_BULK,
 356                      "transport-ats",
 357                      "Telling ATS to destroy session %p from peer %s\n",
 358                      session,
 359                      GNUNET_i2s (peer));
 360   GNUNET_ATS_address_destroyed (GST_ats, peer, NULL, NULL, 0, session);
 361   GST_neighbours_session_terminated (peer, session);
 362 }
 363
 364
 365 /**
 366  * Function called by ATS to notify the callee that the
 367  * assigned bandwidth or address for a given peer was changed.  If the
 368  * callback is called with address/bandwidth assignments of zero, the
 369  * ATS disconnect function will still be called once the disconnect
 370  * actually happened.
 371  *
 372  * @param cls closure
 373  * @param peer identity of the peer
 374  * @param plugin_name name of the transport plugin, NULL to disconnect
 375  * @param session session to use (if available)
 376  * @param plugin_addr address to use (if available)
 377  * @param plugin_addr_len number of bytes in addr
 378  * @param bandwidth_out assigned outbound bandwidth for the connection, 0 to disconnect from peer
 379  * @param bandwidth_in assigned inbound bandwidth for the connection, 0 to disconnect from peer
 380  */
 381 static void
 382 ats_request_address_change (void *cls, const struct GNUNET_PeerIdentity *peer,
 383                             const char *plugin_name,
 384                             const void *plugin_addr, size_t plugin_addr_len,
 385                             struct Session *session,
 386                             struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
 387                             struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
 388                             const struct GNUNET_ATS_Information * ats,
 389                             uint32_t ats_count)
 390 {
 391   uint32_t bw_in = ntohl (bandwidth_in.value__);
 392   uint32_t bw_out = ntohl (bandwidth_out.value__);
 393   struct QuotaSetMessage msg;
 394
 395   /* ATS tells me to disconnect from peer*/
 396   if ((bw_in == 0) && (bw_out == 0))
 397   {
 398 #if DEBUG_TRANSPORT
 399     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 400                 "ATS tells me to disconnect from peer `%s'\n",
 401                 GNUNET_i2s (peer));
 402 #endif
 403     GST_neighbours_force_disconnect(peer);
 404     return;
 405   }
 406   if (GNUNET_YES !=
 407       GST_neighbours_switch_to_address (peer, plugin_name, plugin_addr,
 408                                         plugin_addr_len, session, ats, ats_count))
 409   {
 410 #if DEBUG_TRANSPORT
 411     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 412                 "Connection is not yet up, ignoring quota for now\n");
 413 #endif
 414     /* FIXME: maybe we should let ATS know somehow?  This is a problem
 415        with the design; ATS may assign bandwidth, but we don't use it;
 416        the current ATS API doesn't give us a good way to sync the
 417        connection status between ATS and TRANSPORT */
 418     return;
 419   }
 420 #if DEBUG_TRANSPORT
 421   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 422               "Sending outbound quota of %u Bps for peer `%s' to all clients\n",
 423               ntohl (bandwidth_out.value__), GNUNET_i2s (peer));
 424 #endif
 425   msg.header.size = htons (sizeof (struct QuotaSetMessage));
 426   msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA);
 427   msg.quota = bandwidth_out;
 428   msg.peer = (*peer);
 429   GST_clients_broadcast (&msg.header, GNUNET_NO);
 430 #if DEBUG_TRANSPORT
 431   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 432               "Setting inbound quota of %u for peer `%s' to \n",
 433               ntohl (bandwidth_in.value__), GNUNET_i2s (peer));
 434 #endif
 435   GST_neighbours_set_incoming_quota (peer, bandwidth_in);
 436 }
 437
 438
 439 /**
 440  * Function called to notify transport users that another
 441  * peer connected to us.
 442  *
 443  * @param cls closure
 444  * @param peer the peer that connected
 445  * @param ats performance data
 446  * @param ats_count number of entries in ats
 447  */
 448 static void
 449 neighbours_connect_notification (void *cls,
 450                                  const struct GNUNET_PeerIdentity *peer,
 451                                  const struct GNUNET_ATS_Information
 452                                  *ats, uint32_t ats_count)
 453 {
 454   size_t len = sizeof (struct ConnectInfoMessage) +
 455       ats_count * sizeof (struct GNUNET_ATS_Information);
 456   char buf[len];
 457   memset (&buf, 0, len);
 458   struct ConnectInfoMessage *connect_msg = (struct ConnectInfoMessage *) buf;
 459
 460   connect_msg->header.size = htons (sizeof (buf));
 461   connect_msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
 462   connect_msg->ats_count = htonl (ats_count);
 463   connect_msg->id = *peer;
 464   memcpy (&connect_msg->ats, &connect_msg->ats,
 465           ats_count * sizeof (struct GNUNET_ATS_Information));
 466   GST_clients_broadcast (&connect_msg->header, GNUNET_NO);
 467 }
 468
 469
 470 /**
 471  * Function called to notify transport users that another
 472  * peer disconnected from us.
 473  *
 474  * @param cls closure
 475  * @param peer the peer that disconnected
 476  */
 477 static void
 478 neighbours_disconnect_notification (void *cls,
 479                                     const struct GNUNET_PeerIdentity *peer)
 480 {
 481   struct DisconnectInfoMessage disconnect_msg;
 482
 483   disconnect_msg.header.size = htons (sizeof (struct DisconnectInfoMessage));
 484   disconnect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT);
 485   disconnect_msg.reserved = htonl (0);
 486   disconnect_msg.peer = *peer;
 487   GST_clients_broadcast (&disconnect_msg.header, GNUNET_NO);
 488 }
 489
 490
 491 /**
 492  * Function called when the service shuts down.  Unloads our plugins
 493  * and cancels pending validations.
 494  *
 495  * @param cls closure, unused
 496  * @param tc task context (unused)
 497  */
 498 static void
 499 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 500 {
 501   GST_validation_stop ();
 502   GST_plugins_unload ();
 503   GST_neighbours_stop ();
 504   GNUNET_ATS_scheduling_done (GST_ats);
 505   GST_ats = NULL;
 506   GST_clients_stop ();
 507   GST_blacklist_stop ();
 508   GST_hello_stop ();
 509
 510   if (GST_peerinfo != NULL)
 511   {
 512     GNUNET_PEERINFO_disconnect (GST_peerinfo);
 513     GST_peerinfo = NULL;
 514   }
 515   if (GST_stats != NULL)
 516   {
 517     GNUNET_STATISTICS_destroy (GST_stats, GNUNET_NO);
 518     GST_stats = NULL;
 519   }
 520   if (GST_my_private_key != NULL)
 521   {
 522     GNUNET_CRYPTO_rsa_key_free (GST_my_private_key);
 523     GST_my_private_key = NULL;
 524   }
 525 }
 526
 527
 528 /**
 529  * Initiate transport service.
 530  *
 531  * @param cls closure
 532  * @param server the initialized server
 533  * @param c configuration to use
 534  */
 535 static void
 536 run (void *cls, struct GNUNET_SERVER_Handle *server,
 537      const struct GNUNET_CONFIGURATION_Handle *c)
 538 {
 539   char *keyfile;
 540
 541   /* setup globals */
 542   GST_cfg = c;
 543   if (GNUNET_OK !=
 544       GNUNET_CONFIGURATION_get_value_filename (c, "GNUNETD", "HOSTKEY",
 545                                                &keyfile))
 546   {
 547     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 548                 _
 549                 ("Transport service is lacking key configuration settings.  Exiting.\n"));
 550     GNUNET_SCHEDULER_shutdown ();
 551     return;
 552   }
 553   GST_my_private_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
 554   GNUNET_free (keyfile);
 555   if (GST_my_private_key == NULL)
 556   {
 557     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 558                 _("Transport service could not access hostkey.  Exiting.\n"));
 559     GNUNET_SCHEDULER_shutdown ();
 560     return;
 561   }
 562   GST_stats = GNUNET_STATISTICS_create ("transport", c);
 563   GST_peerinfo = GNUNET_PEERINFO_connect (c);
 564   GNUNET_CRYPTO_rsa_key_get_public (GST_my_private_key, &GST_my_public_key);
 565   GNUNET_CRYPTO_hash (&GST_my_public_key, sizeof (GST_my_public_key),
 566                       &GST_my_identity.hashPubKey);
 567   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
 568                                 NULL);
 569   if (GST_peerinfo == NULL)
 570   {
 571     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 572                 _("Could not access PEERINFO service.  Exiting.\n"));
 573     GNUNET_SCHEDULER_shutdown ();
 574     return;
 575   }
 576
 577   /* start subsystems */
 578   GST_hello_start (&process_hello_update, NULL);
 579   GST_blacklist_start (server);
 580   GST_plugins_load (&plugin_env_receive_callback,
 581                     &plugin_env_address_change_notification,
 582                     &plugin_env_session_end);
 583   GST_ats = GNUNET_ATS_scheduling_init (GST_cfg, &ats_request_address_change, NULL);
 584   GST_neighbours_start (NULL, &neighbours_connect_notification,
 585                         &neighbours_disconnect_notification);
 586   GST_clients_start (server);
 587   GST_validation_start ();
 588 }
 589
 590
 591 /**
 592  * The main function for the transport service.
 593  *
 594  * @param argc number of arguments from the command line
 595  * @param argv command line arguments
 596  * @return 0 ok, 1 on error
 597  */
 598 int
 599 main (int argc, char *const *argv)
 600 {
 601   return (GNUNET_OK ==
 602           GNUNET_SERVICE_run (argc, argv, "transport",
 603                               GNUNET_SERVICE_OPTION_NONE, &run, NULL)) ? 0 : 1;
 604 }
 605
 606 /* end of file gnunet-service-transport-new.c */