Merge branch 'master' of ssh://gnunet.org/gnunet
[oweals/gnunet.git] / src / transport / test_transport_api_reliability.c
index 09d23b78987100f93e4e2d28e4dc445b00c632ab..375a935c8c0c3852d1c93a26b9430df7e835dceb 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2009, 2010 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2009, 2010, 2016 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
 
      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., 59 Temple Place - Suite 330,
-     Boston, MA 02111-1307, USA.
+     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+     Boston, MA 02110-1301, USA.
 */
 /**
  * @file transport/test_transport_api_reliability.c
  * @brief base test case for transport implementations
  *
- * This test case serves as a base for tcp and http
- * transport test cases to check that the transports
- * achieve reliable message delivery.
+ * This test case serves ensures that messages are reliably sent between peers
+ *
+ * This test sends TOTAL_MSGS with message type MTYPE from peer 1 to peer 2
+ * and ensures that all message were received.
  */
 #include "platform.h"
-#include "gnunet_common.h"
-#include "gnunet_hello_lib.h"
-#include "gnunet_getopt_lib.h"
-#include "gnunet_os_lib.h"
-#include "gnunet_program_lib.h"
-#include "gnunet_scheduler_lib.h"
-#include "gnunet_server_lib.h"
 #include "gnunet_transport_service.h"
 #include "gauger.h"
-#include "transport.h"
 #include "transport-testing.h"
 
-#define VERBOSE GNUNET_NO
-
-#define VERBOSE_ARM GNUNET_NO
-
-#define START_ARM GNUNET_YES
-
 /**
- * How long until we give up on transmitting the message?
- */
-#define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1500)
-
-static int ok;
-
-static GNUNET_SCHEDULER_TaskIdentifier die_task;
-
-struct PeerContext *p1;
-
-struct PeerContext *p2;
-
-struct GNUNET_TRANSPORT_TransmitHandle *th;
-
-char *cfg_file_p1;
-
-char *cfg_file_p2;
-
-/*
- * Testcase specific declarations
+ * Allow making the problem "bigger".
  */
+#define FACTOR 1
 
 /**
+ * Total number of messages to send
+ *
  * Note that this value must not significantly exceed
- * 'MAX_PENDING' in 'gnunet-service-transport.c', otherwise
+ * 'MAX_PENDING' in 'gnunet-service-transport_clients.c', otherwise
  * messages may be dropped even for a reliable transport.
  */
-#define TOTAL_MSGS (1024 * 2)
-
-#define MTYPE 12345
-
-struct TestMessage
-{
-  struct GNUNET_MessageHeader header;
-  uint32_t num;
-};
+#define TOTAL_MSGS (1024 * 3 * FACTOR)
 
-static char *test_name;
-static char *test_plugin;
+/**
+ * Testcase timeout
+ */
+#define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 450 * FACTOR)
 
-static int msg_scheduled;
-static int msg_sent;
-static int msg_recv_expected;
-static int msg_recv;
+/**
+ * If we are in an "xhdr" test, the factor by which we divide
+ * #TOTAL_MSGS for a more sane test duration.
+ */
+static unsigned int xhdr = 1;
 
-static int test_failed;
+static struct GNUNET_TRANSPORT_TESTING_ConnectCheckContext *ccc;
 
+/**
+ * Total amount of bytes sent
+ */
 static unsigned long long total_bytes;
 
+/**
+ * Time of start
+ */
 static struct GNUNET_TIME_Absolute start_time;
 
-/*
- * END Testcase specific declarations
+/**
+ * No. of last message received
  */
+static unsigned int msg_recv;
 
-#if VERBOSE
-#define OKPP do { ok++; fprintf (stderr, "Now at stage %u at %s:%u\n", ok, __FILE__, __LINE__); } while (0)
-#else
-#define OKPP do { ok++; } while (0)
-#endif
+/**
+ * Bitmap storing which messages were received
+ */
+static char bitmap[TOTAL_MSGS / 8];
 
 
-static void
-end ()
+/**
+ * Get the desired message size for message number @a iter.
+ */
+static size_t
+get_size (unsigned int iter)
 {
-  unsigned long long delta;
-
-  char *value_name;
-
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Stopping peers\n");
+  size_t ret;
 
-  delta = GNUNET_TIME_absolute_get_duration (start_time).rel_value;
-  fprintf (stderr, "\nThroughput was %llu kb/s\n",
-           total_bytes * 1000 / 1024 / delta);
-  GNUNET_asprintf (&value_name, "reliable_%s", test_plugin);
-  GAUGER ("TRANSPORT", value_name, (int) (total_bytes * 1000 / 1024 / delta),
-          "kb/s");
-  GNUNET_free (value_name);
+  ret = (iter * iter * iter);
+#ifndef LINUX
+  /* FreeBSD/OSX etc. Unix DGRAMs do not work
+   * with large messages */
+  if (0 == strcmp ("unix", ccc->test_plugin))
+    ret = sizeof (struct GNUNET_TRANSPORT_TESTING_TestMessage) + (ret % 1024);
+#endif
+  ret = sizeof (struct GNUNET_TRANSPORT_TESTING_TestMessage) + (ret % 60000);
+  return ret;
+}
 
-  if (die_task != GNUNET_SCHEDULER_NO_TASK)
-    GNUNET_SCHEDULER_cancel (die_task);
 
-  if (th != NULL)
-    GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
-  th = NULL;
+/**
+ * Implementation of the callback for obtaining the
+ * size of messages for transmission.  Counts the total
+ * number of bytes sent as a side-effect.
+ *
+ * @param cnt_down count down from `TOTAL_MSGS - 1`
+ * @return message size of the message
+ */
+static size_t
+get_size_cnt (unsigned int cnt_down)
+{
+  size_t ret = get_size (TOTAL_MSGS / xhdr - 1 - cnt_down);
 
-  GNUNET_TRANSPORT_TESTING_stop_peer (p1);
-  GNUNET_TRANSPORT_TESTING_stop_peer (p2);
+  total_bytes += ret;
+  return ret;
 }
 
-static void
-end_badly ()
+
+/**
+ * Sets a bit active in the bitmap.
+ *
+ * @param bitIdx which bit to set
+ * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
+ */
+static int
+set_bit (unsigned int bitIdx)
 {
-  die_task = GNUNET_SCHEDULER_NO_TASK;
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Fail! Stopping peers\n");
+  size_t arraySlot;
+  unsigned int targetBit;
 
-  if (th != NULL)
-    GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
-  th = NULL;
+  if (bitIdx >= sizeof (bitmap) * 8)
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                "tried to set bit %u of %u(!?!?)\n",
+                bitIdx,
+                (unsigned int) sizeof (bitmap) * 8);
+    return GNUNET_SYSERR;
+  }
+  arraySlot = bitIdx / 8;
+  targetBit = (1L << (bitIdx % 8));
+  bitmap[arraySlot] |= targetBit;
+  return GNUNET_OK;
+}
 
-  if (p1 != NULL)
-    GNUNET_TRANSPORT_TESTING_stop_peer (p1);
-  if (p2 != NULL)
-    GNUNET_TRANSPORT_TESTING_stop_peer (p2);
 
-  ok = GNUNET_SYSERR;
+/**
+ * Obtain a bit from bitmap.
+ * @param map the bitmap
+ * @param bit index from bitmap
+ *
+ * @return Bit @a bit from @a map
+ */
+static int
+get_bit (const char *map,
+         unsigned int bit)
+{
+  if (bit > TOTAL_MSGS)
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                "get bit %u of %u(!?!?)\n",
+                bit,
+                (unsigned int) sizeof (bitmap) * 8);
+    return 0;
+  }
+  return ((map)[bit >> 3] & (1 << (bit & 7))) > 0;
 }
 
 
-static unsigned int
-get_size (unsigned int iter)
+static void
+custom_shutdown (void *cls)
 {
-  unsigned int ret;
+  unsigned long long delta;
+  unsigned long long rate;
+  int ok;
+
+  /* Calculcate statistics   */
+  delta = GNUNET_TIME_absolute_get_duration (start_time).rel_value_us;
+  rate = (1000LL* 1000ll * total_bytes) / (1024 * delta);
+  FPRINTF (stderr,
+           "\nThroughput was %llu KiBytes/s\n",
+           rate);
+  {
+    char *value_name;
+
+    GNUNET_asprintf (&value_name,
+                     "unreliable_%s",
+                     ccc->test_plugin);
+    GAUGER ("TRANSPORT",
+            value_name,
+            (int) rate,
+            "kb/s");
+    GNUNET_free (value_name);
+  }
 
-  ret = (iter * iter * iter);
-  return sizeof (struct TestMessage) + (ret % 60000);
+  ok = 0;
+  for (unsigned int i = 0; i < TOTAL_MSGS / xhdr; i++)
+  {
+    if (get_bit (bitmap, i) == 0)
+    {
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                  "Did not receive message %d\n",
+                  i);
+      ok = -1;
+    }
+  }
+  if (0 != ok)
+    ccc->global_ret = GNUNET_SYSERR; /* fail: messages missing! */
 }
 
 
 static void
-notify_receive (void *cls, const struct GNUNET_PeerIdentity *peer,
-                const struct GNUNET_MessageHeader *message,
-                const struct GNUNET_TRANSPORT_ATS_Information *ats,
-                uint32_t ats_count)
+notify_receive (void *cls,
+                struct GNUNET_TRANSPORT_TESTING_PeerContext *receiver,
+                const struct GNUNET_PeerIdentity *sender,
+                const struct GNUNET_TRANSPORT_TESTING_TestMessage *hdr)
 {
   static int n;
   unsigned int s;
   char cbuf[GNUNET_SERVER_MAX_MESSAGE_SIZE - 1];
-  const struct TestMessage *hdr;
 
-  hdr = (const struct TestMessage *) message;
-  s = get_size (n);
-  if (MTYPE != ntohs (message->type))
+  if (GNUNET_TRANSPORT_TESTING_SIMPLE_MTYPE != ntohs (hdr->header.type))
     return;
-  msg_recv_expected = n;
   msg_recv = ntohl (hdr->num);
-  if (ntohs (message->size) != (s))
-  {
-    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
-                "Expected message %u of size %u, got %u bytes of message %u\n",
-                n, s, ntohs (message->size), ntohl (hdr->num));
-    if (die_task != GNUNET_SCHEDULER_NO_TASK)
-      GNUNET_SCHEDULER_cancel (die_task);
-    test_failed = GNUNET_YES;
-    die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
-    return;
-  }
-  if (ntohl (hdr->num) != n)
+  s = get_size (ntohl (hdr->num));
+
+  if (ntohs (hdr->header.size) != s)
   {
     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                 "Expected message %u of size %u, got %u bytes of message %u\n",
-                n, s, ntohs (message->size), ntohl (hdr->num));
-    if (die_task != GNUNET_SCHEDULER_NO_TASK)
-      GNUNET_SCHEDULER_cancel (die_task);
-    test_failed = GNUNET_YES;
-    die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
+                (uint32_t) ntohl (hdr->num),
+                s,
+                ntohs (hdr->header.size),
+                (uint32_t) ntohl (hdr->num));
+    ccc->global_ret = GNUNET_SYSERR;
+    GNUNET_SCHEDULER_shutdown ();
     return;
   }
-  memset (cbuf, n, s - sizeof (struct TestMessage));
-  if (0 != memcmp (cbuf, &hdr[1], s - sizeof (struct TestMessage)))
+
+  memset (cbuf,
+         ntohl (hdr->num),
+         s - sizeof (struct GNUNET_TRANSPORT_TESTING_TestMessage));
+  if (0 !=
+      memcmp (cbuf,
+             &hdr[1],
+             s - sizeof (struct GNUNET_TRANSPORT_TESTING_TestMessage)))
   {
     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
-                "Expected message %u with bits %u, but body did not match\n", n,
-                (unsigned char) n);
-    if (die_task != GNUNET_SCHEDULER_NO_TASK)
-      GNUNET_SCHEDULER_cancel (die_task);
-    test_failed = GNUNET_YES;
-    die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
+                "Expected message %u with bits %u, but body did not match\n",
+                (uint32_t) ntohl (hdr->num),
+                (unsigned char) ntohl (hdr->num));
+    ccc->global_ret = GNUNET_SYSERR;
+    GNUNET_SCHEDULER_shutdown ();
     return;
   }
 #if VERBOSE
-  if (ntohl (hdr->num) % 5000 == 0)
+  if (0 == ntohl (hdr->num) % 5)
   {
-    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got message %u of size %u\n",
-                ntohl (hdr->num), ntohs (message->size));
+    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+                "Got message %u of size %u\n",
+                (uint32_t) ntohl (hdr->num),
+                ntohs (hdr->header.size));
   }
 #endif
   n++;
-  if (0 == (n % (TOTAL_MSGS / 100)))
+  if (GNUNET_SYSERR == set_bit (ntohl (hdr->num)))
   {
-    fprintf (stderr, ".");
-    if (die_task != GNUNET_SCHEDULER_NO_TASK)
-      GNUNET_SCHEDULER_cancel (die_task);
-    die_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly, NULL);
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                  "Message id %u is bigger than maxmimum number of messages %u expected\n",
+                  (uint32_t) ntohl (hdr->num),
+                  TOTAL_MSGS / xhdr);
   }
-  if (n == TOTAL_MSGS)
+  if (0 == (n % (TOTAL_MSGS / xhdr / 100)))
   {
-    ok = 0;
-    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "All messages received\n");
-    end ();
+    FPRINTF (stderr, "%s",  ".");
   }
-}
-
-
-static size_t
-notify_ready (void *cls, size_t size, void *buf)
-{
-  static int n;
-  char *cbuf = buf;
-  struct TestMessage hdr;
-  unsigned int s;
-  unsigned int ret;
-
-  if (buf == NULL)
-  {
-    GNUNET_break (0);
-    ok = 42;
-    return 0;
-  }
-  th = NULL;
-  ret = 0;
-  s = get_size (n);
-  GNUNET_assert (size >= s);
-  GNUNET_assert (buf != NULL);
-  cbuf = buf;
-  do
-  {
-    hdr.header.size = htons (s);
-    hdr.header.type = htons (MTYPE);
-    hdr.num = htonl (n);
-    msg_sent = n;
-    memcpy (&cbuf[ret], &hdr, sizeof (struct TestMessage));
-    ret += sizeof (struct TestMessage);
-    memset (&cbuf[ret], n, s - sizeof (struct TestMessage));
-    ret += s - sizeof (struct TestMessage);
-#if VERBOSE
-    if (n % 5000 == 0)
-    {
-      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Sending message %u of size %u\n", n,
-                  s);
-    }
-#endif
-    n++;
-    s = get_size (n);
-    if (0 == GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 16))
-      break;                    /* sometimes pack buffer full, sometimes not */
-  }
-  while (size - ret >= s);
-  if (n < TOTAL_MSGS)
-  {
-    if (th == NULL)
-      th = GNUNET_TRANSPORT_notify_transmit_ready (p2->th, &p1->id, s, 0,
-                                                   TIMEOUT, &notify_ready,
-                                                   NULL);
-    msg_scheduled = n;
-  }
-  if (n % 5000 == 0)
-  {
-    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-                "Returning total message block of size %u\n", ret);
-  }
-  total_bytes += ret;
-  if (n == TOTAL_MSGS)
+  if (n == TOTAL_MSGS / xhdr)
   {
-    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "All messages sent\n");
+    /* end testcase with success */
+    ccc->global_ret = GNUNET_OK;
+    GNUNET_SCHEDULER_shutdown ();
   }
-  return ret;
-}
-
-
-static void
-notify_connect (void *cls, const struct GNUNET_PeerIdentity *peer,
-                const struct GNUNET_TRANSPORT_ATS_Information *ats,
-                uint32_t ats_count)
-{
-
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer `%4s' connected to us (%p)!\n",
-              GNUNET_i2s (peer), cls);
-
-  if (cls == p1)
-  {
-    GNUNET_TRANSPORT_set_quota (p1->th, &p2->id,
-                                GNUNET_BANDWIDTH_value_init (1024 * 1024 *
-                                                             1024),
-                                GNUNET_BANDWIDTH_value_init (1024 * 1024 *
-                                                             1024));
-  }
-  else if (cls == p2)
-  {
-    GNUNET_TRANSPORT_set_quota (p2->th, &p1->id,
-                                GNUNET_BANDWIDTH_value_init (1024 * 1024 *
-                                                             1024),
-                                GNUNET_BANDWIDTH_value_init (1024 * 1024 *
-                                                             1024));
-  }
-}
-
-
-static void
-notify_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
-{
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer `%4s' disconnected (%p)!\n",
-              GNUNET_i2s (peer), cls);
-}
-
-static void
-sendtask ()
-{
-  start_time = GNUNET_TIME_absolute_get ();
-  th = GNUNET_TRANSPORT_notify_transmit_ready (p2->th, &p1->id, get_size (0), 0,
-                                               TIMEOUT, &notify_ready, NULL);
 }
 
-static void
-testing_connect_cb (struct PeerContext *p1, struct PeerContext *p2, void *cls)
-{
-  char *p1_c = strdup (GNUNET_i2s (&p1->id));
-
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peers connected: %s <-> %s\n", p1_c,
-              GNUNET_i2s (&p2->id));
-  GNUNET_free (p1_c);
-
-  // FIXME: THIS IS REQUIRED! SEEMS TO BE A BUG!
-  GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS, &sendtask, NULL);
-}
-
-static void
-run (void *cls, char *const *args, const char *cfgfile,
-     const struct GNUNET_CONFIGURATION_Handle *cfg)
-{
-  die_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly, NULL);
-
-  p1 = GNUNET_TRANSPORT_TESTING_start_peer (cfg_file_p1, &notify_receive,
-                                            &notify_connect, &notify_disconnect,
-                                            NULL);
-  p2 = GNUNET_TRANSPORT_TESTING_start_peer (cfg_file_p2, &notify_receive,
-                                            &notify_connect, &notify_disconnect,
-                                            NULL);
-
-  GNUNET_TRANSPORT_TESTING_connect_peers (p1, p2, &testing_connect_cb, NULL);
-}
-
-static int
-check ()
-{
-  static char * argv[] = { "SDSD",
-    "-c",
-    "test_transport_api_data.conf",
-#if VERBOSE
-    "-L", "DEBUG",
-#endif
-    NULL
-  };
-  static struct GNUNET_GETOPT_CommandLineOption options[] = {
-    GNUNET_GETOPT_OPTION_END
-  };
-
-#if WRITECONFIG
-  setTransportOptions ("test_transport_api_data.conf");
-#endif
-  ok = 1;
-  GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1, argv,
-                      test_name, "nohelp", options, &run,
-                      &ok);
-
-  return ok;
-}
 
 int
 main (int argc, char *argv[])
 {
-  int ret;
-  int nat_res;
-  //char * test_exec;
-
-  GNUNET_TRANSPORT_TESTING_get_test_sourcename (__FILE__, &test_name);
-
-
-  GNUNET_log_setup (test_name,
-#if VERBOSE
-                    "DEBUG",
-#else
-                    "WARNING",
-#endif
-                    NULL);
-
-  GNUNET_TRANSPORT_TESTING_get_test_plugin (argv[0], test_name, &test_plugin);
-
-  if ((strstr (argv[0], "tcp_nat") != NULL) ||
-      (strstr (argv[0], "udp_nat") != NULL))
-  {
-    nat_res = GNUNET_OS_check_helper_binary ("gnunet-nat-server");
-    if (GNUNET_NO == nat_res)
-    {
-      GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Cannot run NAT test: `%s' %s \n",
-                  "gnunet-nat-server", "SUID not set");
-      return 0;
-    }
-    if (GNUNET_SYSERR == nat_res)
-    {
-      GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Cannot run NAT test: `%s' %s \n",
-                  "gnunet-nat-server", "file not found");
-      return 0;
-    }
-  }
-
-
-  GNUNET_TRANSPORT_TESTING_get_config_name (argv[0], &cfg_file_p1, 1);
-  GNUNET_TRANSPORT_TESTING_get_config_name (argv[0], &cfg_file_p2, 2);
-
-  ret = check ();
-
-  GNUNET_free (cfg_file_p1);
-  GNUNET_free (cfg_file_p2);
-
-  GNUNET_free (test_name);
-  GNUNET_free (test_plugin);
+  if (0 == strstr (argv[0], "xhdr"))
+    xhdr = 30;
+  struct GNUNET_TRANSPORT_TESTING_SendClosure sc = {
+    .num_messages = TOTAL_MSGS / xhdr,
+    .get_size_cb = &get_size_cnt
+  };
+  struct GNUNET_TRANSPORT_TESTING_ConnectCheckContext my_ccc = {
+    .connect_continuation = &GNUNET_TRANSPORT_TESTING_simple_send,
+    .connect_continuation_cls = &sc,
+    .config_file = "test_transport_api_data.conf",
+    .rec = &notify_receive,
+    .nc = &GNUNET_TRANSPORT_TESTING_log_connect,
+    .nd = &GNUNET_TRANSPORT_TESTING_log_disconnect,
+    .shutdown_task = &custom_shutdown,
+    .timeout = TIMEOUT,
+    .global_ret = GNUNET_SYSERR
+  };
 
-  return ret;
+  ccc = &my_ccc;
+  sc.ccc = ccc;
+  start_time = GNUNET_TIME_absolute_get ();
+  if (GNUNET_OK !=
+      GNUNET_TRANSPORT_TESTING_main (2,
+                                     &GNUNET_TRANSPORT_TESTING_connect_check,
+                                     ccc))
+    return 1;
+  return 0;
 }