[GNUnet-SVN] r22061 - gnunet/src/stream

[gnunet]

Author: harsha
Date: 2012-06-17 14:54:23 +0200 (Sun, 17 Jun 2012)
New Revision: 22061

Added:
   gnunet/src/stream/test_stream_sequence_wraparound.c
Modified:
   gnunet/src/stream/
   gnunet/src/stream/Makefile.am
   gnunet/src/stream/stream_api.c
   gnunet/src/stream/test_stream_big.c
Log:
-testcase for sequence wrap around effect and sequence handling fixes in ack 
handling


Property changes on: gnunet/src/stream
___________________________________________________________________
Modified: svn:ignore
   - test_stream_local
test_stream_api
test-stream-local
test-stream-2peers
test-stream-2peers_halfclose
test-stream-big
Makefile.in
Makefile
.deps

   + test_stream_local
test_stream_api
test_stream_2peers
test_stream_2peers_halfclose
test_stream_big
test_stream_sequence_wraparound
Makefile.in
Makefile
.deps


Modified: gnunet/src/stream/Makefile.am
===================================================================
--- gnunet/src/stream/Makefile.am       2012-06-17 11:07:33 UTC (rev 22060)
+++ gnunet/src/stream/Makefile.am       2012-06-17 12:54:23 UTC (rev 22061)
@@ -23,7 +23,8 @@
  test_stream_2peers \
  test_stream_2peers_halfclose \
  test_stream_local \
- test_stream_big
+ test_stream_big \
+ test_stream_sequence_wraparound
 
 EXTRA_DIST = test_stream_local.conf
 
@@ -60,4 +61,11 @@
 test_stream_big_LDADD = \
  $(top_builddir)/src/stream/libgnunetstream.la \
  $(top_builddir)/src/util/libgnunetutil.la \
+ $(top_builddir)/src/testing_old/libgnunettesting_old.la
+
+test_stream_sequence_wraparound_SOURCES = \
+ test_stream_sequence_wraparound.c
+test_stream_sequence_wraparound_LDADD = \
+ $(top_builddir)/src/stream/libgnunetstream.la \
+ $(top_builddir)/src/util/libgnunetutil.la \
  $(top_builddir)/src/testing_old/libgnunettesting_old.la
\ No newline at end of file

Modified: gnunet/src/stream/stream_api.c
===================================================================
--- gnunet/src/stream/stream_api.c      2012-06-17 11:07:33 UTC (rev 22060)
+++ gnunet/src/stream/stream_api.c      2012-06-17 12:54:23 UTC (rev 22061)
@@ -1384,10 +1384,14 @@
   struct GNUNET_STREAM_HelloAckMessage *msg;
 
   /* Get the random sequence number */
-  socket->write_sequence_number = 
-    GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_NONCE, UINT32_MAX);
+  if (GNUNET_YES == socket->testing_active)
+    socket->write_sequence_number =
+      socket->testing_set_write_sequence_number_value;
+  else
+    socket->write_sequence_number = 
+      GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_NONCE, UINT32_MAX);
   LOG (GNUNET_ERROR_TYPE_DEBUG,
-       "%s: Generated write sequence number %u\n",
+       "%s: write sequence number %u\n",
        GNUNET_i2s (&socket->other_peer),
        (unsigned int) socket->write_sequence_number);
   
@@ -2356,8 +2360,8 @@
 {
   unsigned int packet;
   int need_retransmission;
+  uint32_t sequence_difference;
   
-
   if (0 != memcmp (sender,
                    &socket->other_peer,
                    sizeof (struct GNUNET_PeerIdentity)))
@@ -2367,7 +2371,6 @@
          GNUNET_i2s (&socket->other_peer));
     return GNUNET_YES;
   }
-
   switch (socket->state)
   {
   case (STATE_ESTABLISHED):
@@ -2397,7 +2400,6 @@
     }
     /* FIXME: include the case when write_handle is cancelled - ignore the 
        acks */
-
     LOG (GNUNET_ERROR_TYPE_DEBUG,
          "%s: Received DATA_ACK from %s\n",
          GNUNET_i2s (&socket->other_peer),
@@ -2410,31 +2412,34 @@
       socket->retransmission_timeout_task_id = 
         GNUNET_SCHEDULER_NO_TASK;
     }
-
     for (packet=0; packet < GNUNET_STREAM_ACK_BITMAP_BIT_LENGTH; packet++)
     {
       if (NULL == socket->write_handle->messages[packet]) break;
-      if (ntohl (ack->base_sequence_number)
-          >= ntohl (socket->write_handle->messages[packet]->sequence_number))
-        ackbitmap_modify_bit (&socket->write_handle->ack_bitmap,
-                              packet,
+      /* BS: Base sequence from ack; PS: sequence num of current packet */
+      sequence_difference = ntohl (ack->base_sequence_number)
+        - ntohl (socket->write_handle->messages[packet]->sequence_number);
+      /* case where BS = PS + GNUNET_STREAM_ACK_BITMAP_BIT_LENGTH */
+      if ((sequence_difference == GNUNET_STREAM_ACK_BITMAP_BIT_LENGTH)
+          || ((sequence_difference < GNUNET_STREAM_ACK_BITMAP_BIT_LENGTH)
+              && (0 != sequence_difference))) /* case: BS > PS and BS != PS*/
+      {
+        ackbitmap_modify_bit (&socket->write_handle->ack_bitmap, packet,
                               GNUNET_YES);
-      else
-        if (GNUNET_YES == 
-            ackbitmap_is_bit_set (&socket->write_handle->ack_bitmap,
-                                  ntohl 
(socket->write_handle->messages[packet]->sequence_number)
-                                  - ntohl (ack->base_sequence_number)))
-          ackbitmap_modify_bit (&socket->write_handle->ack_bitmap,
-                                packet,
-                                GNUNET_YES);
+        continue;
+      }
+      if (GNUNET_YES == 
+          ackbitmap_is_bit_set (&socket->write_handle->ack_bitmap,
+                                -sequence_difference))/*inversion as PS >= BS 
*/
+      {
+        ackbitmap_modify_bit (&socket->write_handle->ack_bitmap, packet,
+                              GNUNET_YES);
+      }
     }
-
     /* Update the receive window remaining
        FIXME : Should update with the value from a data ack with greater
        sequence number */
     socket->receiver_window_available = 
       ntohl (ack->receive_window_remaining);
-
     /* Check if we have received all acknowledgements */
     need_retransmission = GNUNET_NO;
     for (packet=0; packet < GNUNET_STREAM_ACK_BITMAP_BIT_LENGTH; packet++)

Modified: gnunet/src/stream/test_stream_big.c
===================================================================
--- gnunet/src/stream/test_stream_big.c 2012-06-17 11:07:33 UTC (rev 22060)
+++ gnunet/src/stream/test_stream_big.c 2012-06-17 12:54:23 UTC (rev 22061)
@@ -19,8 +19,8 @@
 */
 
 /**
- * @file stream/test_stream_local.c
- * @brief Stream API testing between local peers
+ * @file stream/test_stream_big.c
+ * @brief large data transfer using stream API between local peers
  * @author Sree Harsha Totakura
  */
 

Copied: gnunet/src/stream/test_stream_sequence_wraparound.c (from rev 22058, 
gnunet/src/stream/test_stream_big.c)
===================================================================
--- gnunet/src/stream/test_stream_sequence_wraparound.c                         
(rev 0)
+++ gnunet/src/stream/test_stream_sequence_wraparound.c 2012-06-17 12:54:23 UTC 
(rev 22061)
@@ -0,0 +1,425 @@
+/*
+     This file is part of GNUnet.
+     (C) 2011, 2012 Christian Grothoff (and other contributing authors)
+
+     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 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.
+
+     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.
+*/
+
+/**
+ * @file stream/test_stream_sequence_wraparound.c
+ * @brief test cases for sequence wrap around situations during data transfer
+ * @author Sree Harsha Totakura
+ */
+
+#include <string.h>
+
+#include "platform.h"
+#include "gnunet_util_lib.h"
+#include "gnunet_stream_lib.h"
+#include "gnunet_testing_lib.h"
+
+#define LOG(kind, ...)                         \
+  GNUNET_log (kind, __VA_ARGS__);
+
+/**
+ * Structure for holding peer's sockets and IO Handles
+ */
+struct PeerData
+{
+  /**
+   * Peer's stream socket
+   */
+  struct GNUNET_STREAM_Socket *socket;
+
+  /**
+   * Peer's io write handle
+   */
+  struct GNUNET_STREAM_IOWriteHandle *io_write_handle;
+
+  /**
+   * Peer's io read handle
+   */
+  struct GNUNET_STREAM_IOReadHandle *io_read_handle;
+
+  /**
+   * Bytes the peer has written
+   */
+  unsigned int bytes_wrote;
+
+  /**
+   * Byte the peer has read
+   */
+  unsigned int bytes_read;
+};
+
+static struct GNUNET_OS_Process *arm_pid;
+static struct PeerData peer1;
+static struct PeerData peer2;
+static struct GNUNET_STREAM_ListenSocket *peer2_listen_socket;
+static struct GNUNET_CONFIGURATION_Handle *config;
+
+static GNUNET_SCHEDULER_TaskIdentifier abort_task;
+static GNUNET_SCHEDULER_TaskIdentifier test_task;
+static GNUNET_SCHEDULER_TaskIdentifier read_task;
+static GNUNET_SCHEDULER_TaskIdentifier write_task;
+
+#define DATA_SIZE 65536      /* 64KB */
+static uint32_t data[DATA_SIZE / 4];     /* 64KB array */
+static int result;
+
+/**
+ * Shutdown nicely
+ */
+static void
+do_shutdown (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+{
+  GNUNET_STREAM_close (peer1.socket);
+  if (NULL != peer2.socket)
+    GNUNET_STREAM_close (peer2.socket);
+  if (NULL != peer2_listen_socket)
+    GNUNET_STREAM_listen_close (peer2_listen_socket); /* Close listen socket */
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: shutdown\n");
+  if (0 != abort_task)
+  {
+    GNUNET_SCHEDULER_cancel (abort_task);
+  }
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: arm\n");
+  if (0 != GNUNET_OS_process_kill (arm_pid, SIGTERM))
+  {
+    GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
+  }
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: Wait\n");
+  /* Free the duplicated configuration */
+  GNUNET_CONFIGURATION_destroy (config);
+  GNUNET_assert (GNUNET_OK == GNUNET_OS_process_wait (arm_pid));
+  GNUNET_OS_process_destroy (arm_pid);
+}
+
+
+/**
+ * Something went wrong and timed out. Kill everything and set error flag
+ */
+static void
+do_abort (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+{
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: ABORT\n");
+  if (0 != test_task)
+  {
+    GNUNET_SCHEDULER_cancel (test_task);
+  }
+  if (0 != read_task)
+    {
+      GNUNET_SCHEDULER_cancel (read_task);
+    }
+  result = GNUNET_SYSERR;
+  abort_task = 0;
+  do_shutdown (cls, tc);
+}
+
+
+/**
+ * The write completion function; called upon writing some data to stream or
+ * upon error
+ *
+ * @param cls the closure from GNUNET_STREAM_write/read
+ * @param status the status of the stream at the time this function is called
+ * @param size the number of bytes read or written
+ */
+static void 
+write_completion (void *cls,
+                  enum GNUNET_STREAM_Status status,
+                  size_t size)
+{
+  struct PeerData *peer;
+
+  peer = (struct PeerData *) cls;
+  GNUNET_assert (GNUNET_STREAM_OK == status);
+  GNUNET_assert (size < DATA_SIZE);
+  peer->bytes_wrote += size;
+
+  if (peer->bytes_wrote < DATA_SIZE) /* Have more data to send */
+    {
+      peer->io_write_handle =
+        GNUNET_STREAM_write (peer->socket,
+                             ((void *) data) + peer->bytes_wrote,
+                             DATA_SIZE - peer->bytes_wrote,
+                             GNUNET_TIME_relative_multiply
+                             (GNUNET_TIME_UNIT_SECONDS, 5),
+                             &write_completion,
+                             cls);
+      GNUNET_assert (NULL != peer->io_write_handle);
+    }
+  else
+    {
+      LOG (GNUNET_ERROR_TYPE_DEBUG, "Writing successfully finished\n");
+      result = GNUNET_OK;
+      GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
+    }
+}
+
+
+/**
+ * Task for calling STREAM_write with a chunk of random data
+ *
+ * @param cls the peer data entity
+ * @param tc the task context
+ */
+static void
+stream_write_task (void *cls,
+                   const struct GNUNET_SCHEDULER_TaskContext *tc)
+{
+  struct PeerData *peer=cls;
+  unsigned int count;
+
+  write_task = GNUNET_SCHEDULER_NO_TASK;
+  for (count=0; count < DATA_SIZE / 4; count++)
+    {
+      data[count]=GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
+                                            UINT32_MAX);
+    }
+  LOG (GNUNET_ERROR_TYPE_DEBUG, "Generation of random data complete\n");
+  peer->io_write_handle = GNUNET_STREAM_write (peer->socket,
+                                               data,
+                                               DATA_SIZE,
+                                               GNUNET_TIME_relative_multiply
+                                               (GNUNET_TIME_UNIT_SECONDS, 10),
+                                               &write_completion,
+                                               peer);
+  GNUNET_assert (NULL != peer->io_write_handle);
+}
+
+
+/**
+ * Function executed after stream has been established
+ *
+ * @param cls the closure from GNUNET_STREAM_open
+ * @param socket socket to use to communicate with the other side (read/write)
+ */
+static void 
+stream_open_cb (void *cls,
+                struct GNUNET_STREAM_Socket *socket)
+{
+  struct PeerData *peer;
+
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Stream established from peer1\n");
+  peer = (struct PeerData *) cls;
+  peer->bytes_wrote = 0;
+  GNUNET_assert (socket == peer1.socket);
+  GNUNET_assert (socket == peer->socket);
+  write_task = GNUNET_SCHEDULER_add_now (&stream_write_task, peer);
+}
+
+
+/**
+ * Scheduler call back; to be executed when a new stream is connected
+ * Called from listen connect for peer2
+ */
+static void
+stream_read_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
+
+
+/**
+ * Input processor
+ *
+ * @param cls peer2
+ * @param status the status of the stream at the time this function is called
+ * @param data traffic from the other side
+ * @param size the number of bytes available in data read 
+ * @return number of bytes of processed from 'data' (any data remaining should 
be
+ *         given to the next time the read processor is called).
+ */
+static size_t
+input_processor (void *cls,
+                 enum GNUNET_STREAM_Status status,
+                 const void *input_data,
+                 size_t size)
+{
+  struct PeerData *peer = cls;
+
+  GNUNET_assert (GNUNET_STREAM_OK == status);
+  GNUNET_assert (&peer2 == peer);
+  GNUNET_assert (size < DATA_SIZE);
+  GNUNET_assert (0 == memcmp (((void *)data ) + peer->bytes_read, 
+                             input_data, size));
+  peer->bytes_read += size;
+  
+  if (peer->bytes_read < DATA_SIZE)
+  {
+    GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == read_task);
+    read_task = GNUNET_SCHEDULER_add_now (&stream_read_task, &peer2);
+    /* peer->io_read_handle = GNUNET_STREAM_read ((struct GNUNET_STREAM_Socket 
*) */
+    /*                                            peer->socket, */
+    /*                                            
GNUNET_TIME_relative_multiply */
+    /*                                            (GNUNET_TIME_UNIT_SECONDS, 
5), */
+    /*                                            &input_processor, */
+    /*                                            cls); */
+    /* GNUNET_assert (NULL != peer->io_read_handle); */
+  }
+  else 
+  {
+    /* Peer2 has completed reading*/
+    LOG (GNUNET_ERROR_TYPE_DEBUG, "Reading finished successfully\n");
+  } 
+  return size;
+}
+
+  
+/**
+ * Scheduler call back; to be executed when a new stream is connected
+ * Called from listen connect for peer2
+ */
+static void
+stream_read_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+{
+  struct PeerData *peer = cls;
+
+  read_task = GNUNET_SCHEDULER_NO_TASK;
+  GNUNET_assert (&peer2 == peer);  
+  peer->io_read_handle =
+    GNUNET_STREAM_read (peer->socket,
+                        GNUNET_TIME_relative_multiply
+                        (GNUNET_TIME_UNIT_SECONDS, 10),
+                        &input_processor,
+                        peer);
+  GNUNET_assert (NULL != peer->io_read_handle);
+}
+
+
+/**
+ * Functions of this type are called upon new stream connection from other 
peers
+ *
+ * @param cls the closure from GNUNET_STREAM_listen
+ * @param socket the socket representing the stream
+ * @param initiator the identity of the peer who wants to establish a stream
+ *            with us
+ * @return GNUNET_OK to keep the socket open, GNUNET_SYSERR to close the
+ *             stream (the socket will be invalid after the call)
+ */
+static int
+stream_listen_cb (void *cls,
+           struct GNUNET_STREAM_Socket *socket,
+           const struct GNUNET_PeerIdentity *initiator)
+{
+  GNUNET_assert (NULL != socket);
+  GNUNET_assert (socket != peer1.socket);
+
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+              "Peer connected: %s\n", GNUNET_i2s(initiator));
+
+  peer2.socket = socket;
+  peer2.bytes_read = 0;
+  read_task = GNUNET_SCHEDULER_add_now (&stream_read_task, &peer2);
+  return GNUNET_OK;
+}
+
+
+/**
+ * Testing function
+ *
+ * @param cls NULL
+ * @param tc the task context
+ */
+static void
+test (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+{
+  struct GNUNET_PeerIdentity self;
+
+  test_task = GNUNET_SCHEDULER_NO_TASK;
+  /* Get our identity */
+  GNUNET_assert (GNUNET_OK == GNUNET_TESTING_get_peer_identity (config,
+                                                                &self));
+
+  peer2_listen_socket = GNUNET_STREAM_listen (config,
+                                              10, /* App port */
+                                              &stream_listen_cb,
+                                              NULL,
+                                              GNUNET_STREAM_OPTION_END);
+  GNUNET_assert (NULL != peer2_listen_socket);
+
+  /* Connect to stream library */
+  peer1.socket = GNUNET_STREAM_open (config,
+                                     &self,         /* Null for local peer? */
+                                     10,           /* App port */
+                                     &stream_open_cb,
+                                     (void *) &peer1,
+                                     
GNUNET_STREAM_OPTION_TESTING_SET_WRITE_SEQUENCE_NUMBER,
+                                     UINT32_MAX - GNUNET_CRYPTO_random_u32
+                                     (GNUNET_CRYPTO_QUALITY_WEAK, 64),
+                                     GNUNET_STREAM_OPTION_END);
+  GNUNET_assert (NULL != peer1.socket);                  
+}
+
+
+/**
+ * Initialize framework and start test
+ */
+static void
+run (void *cls, char *const *args, const char *cfgfile,
+     const struct GNUNET_CONFIGURATION_Handle *cfg)
+{
+  /* Duplicate the configuration */
+  config = GNUNET_CONFIGURATION_dup (cfg);
+  arm_pid =
+    GNUNET_OS_start_process (GNUNET_YES, NULL, NULL, "gnunet-service-arm",
+                             "gnunet-service-arm",
+#if VERBOSE_ARM
+                             "-L", "DEBUG",
+#endif
+                             "-c", "test_stream_local.conf", NULL);
+  
+  abort_task =
+    GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
+                                  (GNUNET_TIME_UNIT_SECONDS, 60), &do_abort,
+                                  NULL);
+  
+  test_task = GNUNET_SCHEDULER_add_now (&test, NULL);  
+}
+
+/**
+ * Main function
+ */
+int main (int argc, char **argv)
+{
+  int ret;
+  
+  char *const argv2[] = { "test-stream-big",
+                          "-c", "test_stream_local.conf",
+                          "-L", "DEBUG",
+                          NULL
+  };
+  
+  struct GNUNET_GETOPT_CommandLineOption options[] = {
+    GNUNET_GETOPT_OPTION_END
+  };
+  
+  ret =
+    GNUNET_PROGRAM_run ((sizeof (argv2) / sizeof (char *)) - 1, argv2,
+                        "test-stream-big", "nohelp", options, &run, NULL);
+  
+  if (GNUNET_OK != ret)
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "run failed with error code %d\n",
+                ret);
+    return 1;
+  }
+  if (GNUNET_SYSERR == result)
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "test failed\n");
+    return 1;
+  }
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test ok\n");
+  return 0;
+}