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