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