Merge branch 'master' of git+ssh://gnunet.org/gnunet
[oweals/gnunet.git] / src / transport / gnunet-transport.c
index eec52cdce3d38e154725a22b10ab1dad3e0cc816..c3c1afc38b7f0630e87c169b1526e17c0a1b5c98 100644 (file)
@@ -1,21 +1,21 @@
 /*
  This file is part of GNUnet.
- Copyright (C) 2011-2014, 2016 GNUnet e.V.
+ Copyright (C) 2011-2014, 2016, 2017 GNUnet e.V.
 
- GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
- by the Free Software Foundation; either version 3, or (at your
- option) any later version.
+ GNUnet is free software: you can redistribute it and/or modify it
under the terms of the GNU Affero General Public License as published
+ by the Free Software Foundation, either version 3 of the License,
+ or (at your option) any later version.
 
  GNUnet is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- General Public License for more details.
Affero General Public License for more details.
 
- You should have received a copy of the GNU General Public License
- along with GNUnet; see the file COPYING.  If not, write to the
- Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
- Boston, MA 02110-1301, USA.
+ You should have received a copy of the GNU Affero General Public License
+ along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+     SPDX-License-Identifier: AGPL3.0-or-later
  */
 
 /**
@@ -23,9 +23,6 @@
  * @brief Tool to help configure, measure and control the transport subsystem.
  * @author Christian Grothoff
  * @author Nathan Evans
- *
- * This utility can be used to test if a transport mechanism for
- * GNUnet is properly configured.
  */
 #include "platform.h"
 #include "gnunet_util_lib.h"
 #include "gnunet_protocols.h"
 #include "gnunet_transport_service.h"
 #include "gnunet_transport_core_service.h"
-#include "gnunet_nat_lib.h"
-
-/**
- * How long do we wait for the NAT test to report success?
- * Should match NAT_SERVER_TIMEOUT in 'nat_test.c'.
- */
-#define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 20)
 
 /**
  * Timeout for a name resolution
@@ -171,91 +161,11 @@ struct PeerResolutionContext
 };
 
 
-/**
- * Context for a plugin test.
- */
-struct TestContext
-{
-  /**
-   * Previous in DLL
-   */
-  struct TestContext *prev;
-
-  /**
-   * Next in DLL
-   */
-  struct TestContext *next;
-
-  /**
-   * Handle to the active NAT test.
-   */
-  struct GNUNET_NAT_Test *tst;
-
-  /**
-   * Task identifier for the timeout.
-   */
-  struct GNUNET_SCHEDULER_Task * tsk;
-
-  /**
-   * Name of plugin under test.
-   */
-  char *name;
-
-  /**
-   * Bound port
-   */
-  unsigned long long bnd_port;
-
-  /**
-   * Advertised ports
-   */
-  unsigned long long adv_port;
-
-};
-
-
-/**
- *
- */
-enum TestResult
-{
-  /**
-   * NAT returned success
-   */
-  NAT_TEST_SUCCESS = GNUNET_OK,
-
-  /**
-   * NAT returned failure
-   */
-  NAT_TEST_FAIL = GNUNET_NO,
-
-  /**
-   * NAT returned failure while running test
-   */
-  NAT_TEST_INTERNAL_FAIL = GNUNET_SYSERR,
-
-  /**
-   * We could not start the test
-   */
-  NAT_TEST_FAILED_TO_START = 2,
-
-  /**
-   * We had a timeout while running the test
-   */
-  NAT_TEST_TIMEOUT = 3
-};
-
-
 /**
  * Benchmarking block size in KB
  */
 #define BLOCKSIZE 4
 
-/**
- * Which peer should we connect to?
- */
-static char *cpid;
-
 /**
  * Handle to transport service.
  */
@@ -296,11 +206,6 @@ static int iterate_connections;
  */
 static int iterate_all;
 
-/**
- * Option -t.
- */
-static int test_configuration;
-
 /**
  * Option -c.
  */
@@ -373,7 +278,7 @@ static struct GNUNET_TRANSPORT_PluginMonitor *pm;
 
 /**
  * Identity of the peer we transmit to / connect to.
- * (equivalent to 'cpid' string).
+ * ('-p' command-line option).
  */
 static struct GNUNET_PeerIdentity pid;
 
@@ -385,7 +290,7 @@ static struct GNUNET_SCHEDULER_Task *op_timeout;
 /**
  * Selected level of verbosity.
  */
-static int verbosity;
+static unsigned int verbosity;
 
 /**
  * Resolver process handle.
@@ -397,16 +302,6 @@ struct GNUNET_OS_Process *resolver;
  */
 static unsigned int address_resolutions;
 
-/**
- * DLL for NAT Test Contexts: head
- */
-static struct TestContext *head;
-
-/**
- * DLL for NAT Test Contexts: tail
- */
-static struct TestContext *tail;
-
 /**
  * DLL: head of validation resolution entries
  */
@@ -585,16 +480,18 @@ operation_timeout (void *cls)
                _("Failed to resolve address for peer `%s'\n"),
                GNUNET_i2s (&cur->addrcp->peer));
 
-      GNUNET_CONTAINER_DLL_remove(rc_head, rc_tail, cur);
+      GNUNET_CONTAINER_DLL_remove(rc_head,
+                                 rc_tail,
+                                 cur);
       GNUNET_TRANSPORT_address_to_string_cancel (cur->asc);
-      GNUNET_free(cur->transport);
-      GNUNET_free(cur->addrcp);
-      GNUNET_free(cur);
+      GNUNET_free (cur->transport);
+      GNUNET_free (cur->addrcp);
+      GNUNET_free (cur);
 
     }
     FPRINTF (stdout,
              "%s",
-             _("Failed to list connections, timeout occured\n"));
+             _("Failed to list connections, timeout occurred\n"));
     GNUNET_SCHEDULER_shutdown ();
     ret = 1;
     return;
@@ -602,186 +499,6 @@ operation_timeout (void *cls)
 }
 
 
-static void
-run_nat_test (void);
-
-
-/**
- * Display the result of the test.
- *
- * @param tc test context
- * @param result #GNUNET_YES on success
- */
-static void
-display_test_result (struct TestContext *tc,
-                     enum TestResult result)
-{
-  switch (result) {
-    case NAT_TEST_FAIL:
-      FPRINTF (stderr,
-               _("Configuration for plugin `%s' did not work!\n"),
-               tc->name);
-      break;
-    case NAT_TEST_SUCCESS:
-      FPRINTF (stderr,
-               _("Configuration for plugin `%s' did work!\n"),
-               tc->name);
-      break;
-    case NAT_TEST_INTERNAL_FAIL:
-      FPRINTF (stderr,
-               _("Internal NAT error while running test for plugin `%s'\n"),
-               tc->name);
-      break;
-    case NAT_TEST_FAILED_TO_START:
-      FPRINTF (stderr,
-               _("Failed to start NAT test for plugin `%s'\n"),
-               tc->name);
-      break;
-    case NAT_TEST_TIMEOUT:
-      FPRINTF (stderr,
-               _("Timeout while waiting for result of NAT test for plugin `%s'\n"),
-               tc->name);
-      break;
-    default:
-      FPRINTF (stderr,
-               _("Configuration for plugin `%s' did not work!\n"),
-               tc->name);
-      break;
-  }
-  if (NULL != tc->tsk)
-  {
-    GNUNET_SCHEDULER_cancel (tc->tsk);
-    tc->tsk = NULL;
-  }
-  if (NULL != tc->tst)
-  {
-    GNUNET_NAT_test_stop (tc->tst);
-    tc->tst = NULL;
-  }
-
-  GNUNET_CONTAINER_DLL_remove (head, tail, tc);
-  GNUNET_free (tc->name);
-  GNUNET_free (tc);
-
-  if ((NULL == head) && (NULL != resolver))
-  {
-    GNUNET_break (0 == GNUNET_OS_process_kill (resolver,
-                                               GNUNET_TERM_SIG));
-    GNUNET_OS_process_destroy (resolver);
-    resolver = NULL;
-  }
-  if (NULL != head)
-    run_nat_test ();
-}
-
-
-/**
- * Function called by NAT to report the outcome of the nat-test.
- * Clean up and update GUI.
- *
- * @param cls test context
- * @param result status code
- */
-static void
-result_callback (void *cls,
-                 enum GNUNET_NAT_StatusCode result)
-{
-  struct TestContext *tc = cls;
-
-  display_test_result (tc,
-                      result);
-}
-
-
-static void
-run_nat_test ()
-{
-  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
-              "Running test for plugin `%s' using bind port %u and advertised port %u \n",
-              head->name,
-              (uint16_t) head->bnd_port,
-              (uint16_t) head->adv_port);
-
-  head->tst = GNUNET_NAT_test_start (cfg,
-                                    (0 == strcasecmp (head->name, "udp"))
-                                    ? GNUNET_NO : GNUNET_YES,
-                                    (uint16_t) head->bnd_port,
-                                    (uint16_t) head->adv_port,
-                                    TIMEOUT,
-                                    &result_callback, head);
-}
-
-
-/**
- * Test our plugin's configuration (NAT traversal, etc.).
- *
- * @param cfg configuration to test
- */
-static void
-do_test_configuration (const struct GNUNET_CONFIGURATION_Handle *cfg)
-{
-  char *plugins;
-  char *tok;
-  unsigned long long bnd_port;
-  unsigned long long adv_port;
-  struct TestContext *tc;
-  char *binary;
-
-  if (GNUNET_OK
-      != GNUNET_CONFIGURATION_get_value_string (cfg, "transport", "plugins",
-          &plugins))
-  {
-    FPRINTF (stderr, "%s", _
-    ("No transport plugins configured, peer will never communicate\n"));
-    ret = 4;
-    return;
-  }
-
-  for (tok = strtok (plugins, " "); tok != NULL ; tok = strtok (NULL, " "))
-  {
-    char section[12 + strlen (tok)];
-    GNUNET_snprintf (section, sizeof(section), "transport-%s", tok);
-    if (GNUNET_OK
-        != GNUNET_CONFIGURATION_get_value_number (cfg, section, "PORT",
-            &bnd_port))
-    {
-      FPRINTF (stderr,
-          _("No port configured for plugin `%s', cannot test it\n"), tok);
-      continue;
-    }
-    if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (cfg, section,
-            "ADVERTISED_PORT", &adv_port))
-      adv_port = bnd_port;
-
-    tc = GNUNET_new (struct TestContext);
-    tc->name = GNUNET_strdup (tok);
-    tc->adv_port = adv_port;
-    tc->bnd_port = bnd_port;
-    GNUNET_CONTAINER_DLL_insert_tail (head, tail, tc);
-  }
-  GNUNET_free(plugins);
-
-  if ((NULL != head) && (NULL == resolver))
-  {
-    binary = GNUNET_OS_get_libexec_binary_path ("gnunet-service-resolver");
-    resolver = GNUNET_OS_start_process (GNUNET_YES,
-                                        GNUNET_OS_INHERIT_STD_OUT_AND_ERR,
-                                        NULL, NULL, NULL,
-                                        binary,
-                                        "gnunet-service-resolver", NULL);
-    if (NULL == resolver)
-    {
-      FPRINTF (stderr, _("Failed to start resolver!\n"));
-      return;
-    }
-
-    GNUNET_free(binary);
-    GNUNET_RESOLVER_connect (cfg);
-    run_nat_test ();
-  }
-}
-
-
 /**
  * Function called to notify a client about the socket
  * begin ready to queue more data.  Sends another message.
@@ -938,6 +655,7 @@ monitor_notify_disconnect (void *cls,
  *
  * @param cls closure
  * @param message the message
+ * @return #GNUNET_OK
  */
 static int
 check_dummy (void *cls,
@@ -1006,7 +724,7 @@ print_info (const struct GNUNET_PeerIdentity *id,
              GNUNET_STRINGS_absolute_time_to_string (state_timeout));
   }
   else if ( (GNUNET_YES == iterate_connections) &&
-           (GNUNET_TRANSPORT_is_connected(state)) ) 
+           (GNUNET_TRANSPORT_is_connected(state)) )
   {
     /* Only connected peers, skip state */
     FPRINTF (stdout,
@@ -1100,7 +818,9 @@ process_peer_string (void *cls,
   }
   GNUNET_free (rc->transport);
   GNUNET_free (rc->addrcp);
-  GNUNET_CONTAINER_DLL_remove (rc_head, rc_tail, rc);
+  GNUNET_CONTAINER_DLL_remove (rc_head,
+                              rc_tail,
+                              rc);
   GNUNET_free (rc);
   if ((0 == address_resolutions) && (iterate_connections))
   {
@@ -1364,10 +1084,9 @@ plugin_monitoring_cb (void *cls,
     }
     return; /* shutdown */
   }
-  if ( (NULL != cpid) &&
-       (0 != memcmp (&info->address->peer,
-                     cpid,
-                     sizeof (struct GNUNET_PeerIdentity))) )
+  if (0 != memcmp (&info->address->peer,
+                   &pid,
+                   sizeof (struct GNUNET_PeerIdentity)))
     return; /* filtered */
   if (NULL == addr)
   {
@@ -1516,29 +1235,11 @@ run (void *cls,
      const char *cfgfile,
      const struct GNUNET_CONFIGURATION_Handle *mycfg)
 {
-  GNUNET_MQ_hd_var_size (dummy,
-                         GNUNET_MESSAGE_TYPE_DUMMY,
-                         struct GNUNET_MessageHeader);
+  static struct GNUNET_PeerIdentity zero_pid;
   int counter = 0;
   ret = 1;
 
   cfg = (struct GNUNET_CONFIGURATION_Handle *) mycfg;
-  if (test_configuration)
-  {
-    do_test_configuration (cfg);
-    return;
-  }
-  if ( (NULL != cpid) &&
-       (GNUNET_OK !=
-        GNUNET_CRYPTO_eddsa_public_key_from_string (cpid,
-                                                    strlen (cpid),
-                                                    &pid.public_key)))
-  {
-    FPRINTF (stderr,
-             _("Failed to parse peer identity `%s'\n"),
-             cpid);
-    return;
-  }
 
   counter = benchmark_send + benchmark_receive + iterate_connections
       + monitor_connections + monitor_connects + do_disconnect +
@@ -1573,7 +1274,9 @@ run (void *cls,
 
   if (do_disconnect) /* -D: Disconnect from peer */
   {
-    if (NULL == cpid)
+    if (0 == memcmp (&zero_pid,
+                     &pid,
+                     sizeof (pid)))
     {
       FPRINTF (stderr,
                _("Option `%s' makes no sense without option `%s'.\n"),
@@ -1598,7 +1301,9 @@ run (void *cls,
   }
   else if (benchmark_send) /* -s: Benchmark sending */
   {
-    if (NULL == cpid)
+    if (0 == memcmp (&zero_pid,
+                     &pid,
+                     sizeof (pid)))
     {
       FPRINTF (stderr,
               _("Option `%s' makes no sense without option `%s'.\n"),
@@ -1629,10 +1334,13 @@ run (void *cls,
   else if (benchmark_receive) /* -b: Benchmark receiving */
   {
     struct GNUNET_MQ_MessageHandler handlers[] = {
-      make_dummy_handler (NULL),
+      GNUNET_MQ_hd_var_size (dummy,
+                             GNUNET_MESSAGE_TYPE_DUMMY,
+                             struct GNUNET_MessageHeader,
+                             NULL),
       GNUNET_MQ_handler_end ()
     };
-    
+
     handle = GNUNET_TRANSPORT_core_connect (cfg,
                                            NULL,
                                            handlers,
@@ -1658,7 +1366,7 @@ run (void *cls,
   else if (iterate_connections) /* -i: List information about peers once */
   {
     pic = GNUNET_TRANSPORT_monitor_peers (cfg,
-                                          (NULL == cpid) ? NULL : &pid,
+                                          &pid,
                                           GNUNET_YES,
                                           &process_peer_iteration_cb,
                                           (void *) cfg);
@@ -1671,7 +1379,7 @@ run (void *cls,
     monitored_peers = GNUNET_CONTAINER_multipeermap_create (10,
                                                            GNUNET_NO);
     pic = GNUNET_TRANSPORT_monitor_peers (cfg,
-                                         (NULL == cpid) ? NULL : &pid,
+                                         &pid,
                                           GNUNET_NO,
                                           &process_peer_monitoring_cb,
                                           NULL);
@@ -1719,41 +1427,50 @@ main (int argc,
       char * const *argv)
 {
   int res;
-  static const struct GNUNET_GETOPT_CommandLineOption options[] = {
-    { 'a', "all", NULL,
-      gettext_noop ("print information for all peers (instead of only connected peers)"),
-      0, &GNUNET_GETOPT_set_one, &iterate_all },
-    { 'b', "benchmark", NULL,
-      gettext_noop ("measure how fast we are receiving data from all peers (until CTRL-C)"),
-      0, &GNUNET_GETOPT_set_one, &benchmark_receive },
-    { 'D', "disconnect",
-      NULL, gettext_noop ("disconnect from a peer"), 0,
-      &GNUNET_GETOPT_set_one, &do_disconnect },
-    { 'i', "information", NULL,
-      gettext_noop ("provide information about all current connections (once)"),
-      0, &GNUNET_GETOPT_set_one, &iterate_connections },
-    { 'm', "monitor", NULL,
-      gettext_noop ("provide information about all current connections (continuously)"),
-      0, &GNUNET_GETOPT_set_one, &monitor_connections },
-    { 'e', "events", NULL,
-      gettext_noop ("provide information about all connects and disconnect events (continuously)"),
-      0, &GNUNET_GETOPT_set_one, &monitor_connects },
-    { 'n', "numeric",
-      NULL, gettext_noop ("do not resolve hostnames"), 0,
-      &GNUNET_GETOPT_set_one, &numeric },
-    { 'p', "peer", "PEER",
-      gettext_noop ("peer identity"), 1, &GNUNET_GETOPT_set_string,
-      &cpid },
-    { 'P', "plugins", NULL,
-      gettext_noop ("monitor plugin sessions"), 0, &GNUNET_GETOPT_set_one,
-      &monitor_plugins },
-    { 's', "send", NULL, gettext_noop
-      ("send data for benchmarking to the other peer (until CTRL-C)"), 0,
-      &GNUNET_GETOPT_set_one, &benchmark_send },
-    { 't', "test", NULL,
-      gettext_noop ("test transport configuration (involves external server)"),
-      0, &GNUNET_GETOPT_set_one, &test_configuration },
-    GNUNET_GETOPT_OPTION_VERBOSE (&verbosity),
+  struct GNUNET_GETOPT_CommandLineOption options[] = {
+    GNUNET_GETOPT_option_flag ('a',
+                                  "all",
+                                  gettext_noop ("print information for all peers (instead of only connected peers)"),
+                                  &iterate_all),
+    GNUNET_GETOPT_option_flag ('b',
+                                  "benchmark",
+                                  gettext_noop ("measure how fast we are receiving data from all peers (until CTRL-C)"),
+                                  &benchmark_receive),
+    GNUNET_GETOPT_option_flag ('D',
+                                  "disconnect",
+                                  gettext_noop ("disconnect from a peer"),
+                                  &do_disconnect),
+    GNUNET_GETOPT_option_flag ('i',
+                                  "information",
+                                  gettext_noop ("provide information about all current connections (once)"),
+                                  &iterate_connections),
+    GNUNET_GETOPT_option_flag ('m',
+                                  "monitor",
+                                  gettext_noop ("provide information about all current connections (continuously)"),
+                                  &monitor_connections),
+    GNUNET_GETOPT_option_flag ('e',
+                                  "events",
+                                  gettext_noop ("provide information about all connects and disconnect events (continuously)"),
+                                  &monitor_connects),
+    GNUNET_GETOPT_option_flag ('n',
+                                  "numeric",
+                                  gettext_noop ("do not resolve hostnames"),
+                                  &numeric),
+    GNUNET_GETOPT_option_base32_auto ('p',
+                                          "peer",
+                                          "PEER",
+                                          gettext_noop ("peer identity"),
+                                          &pid),
+    GNUNET_GETOPT_option_flag ('P',
+                                  "plugins",
+                                  gettext_noop ("monitor plugin sessions"),
+                                  &monitor_plugins),
+    GNUNET_GETOPT_option_flag ('s',
+                                  "send",
+                                  gettext_noop
+      ("send data for benchmarking to the other peer (until CTRL-C)"),
+                                  &benchmark_send),
+    GNUNET_GETOPT_option_verbose (&verbosity),
     GNUNET_GETOPT_OPTION_END
   };
 
@@ -1765,7 +1482,7 @@ main (int argc,
                             gettext_noop ("Direct access to transport service."),
                             options,
                             &run, NULL);
-  GNUNET_free((void *) argv);
+  GNUNET_free ((void *) argv);
   if (GNUNET_OK == res)
     return ret;
   return 1;