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