path: root/src/stream/test_stream_2peers_halfclose.c

/*
     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_2peers_halfclose.c
 * @brief Testcases for Stream API halfclosed connections between 2 peers
 * @author Sree Harsha Totakura
 */

#include <string.h>

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_mesh_service.h"
#include "gnunet_stream_lib.h"
#include "gnunet_testing_lib.h"
#include "gnunet_scheduler_lib.h"

#define VERBOSE 1

/**
 * Number of peers
 */
#define NUM_PEERS 2

/**
 * 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;

  /**
   * Peer's shutdown handle
   */
  struct GNUNET_STREAM_ShutdownHandle *shutdown_handle;

  /**
   * Our Peer id
   */
  struct GNUNET_PeerIdentity our_id;

  /**
   * Bytes the peer has written
   */
  unsigned int bytes_wrote;

  /**
   * Byte the peer has read
   */
  unsigned int bytes_read;

  /**
   * GNUNET_YES if the peer has successfully completed the current test
   */
  unsigned int test_ok;

  /**
   * The shutdown operation that has to be used by the stream_shutdown_task
   */
  int shutdown_operation;
};

/**
 * The current peer group
 */
static struct GNUNET_TESTING_PeerGroup *pg;

/**
 * Peer 1 daemon
 */
static struct GNUNET_TESTING_Daemon *d1;

/**
 * Peer 2 daemon
 */
static struct GNUNET_TESTING_Daemon *d2;


/**
 * Peer1 writes first and then calls for SHUT_WR
 * Peer2 reads first and then calls for SHUT_RD
 * Attempt to write again by Peer1 should be rejected
 * Attempt to read again by Peer2 should be rejected
 * Peer1 then reads from Peer2 which writes
 */
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 read_task;

static char *data = "ABCD";
static int result;

/**
 * Enumeration for various tests that are to be passed in the same order as
 * below
 */
enum Test
  {
    /**
     * Peer1 writing; Peer2 reading
     */
    PEER1_WRITE,

    /**
     * Peer1 write shutdown; Peer2 should get an error when it tries to read;
     */
    PEER1_WRITE_SHUTDOWN,

    /**
     * Peer1 reads; Peer2 writes (connection is halfclosed)
     */
    PEER1_HALFCLOSE_READ,

    /**
     * Peer1 attempts to write; Should fail with stream already shutdown error
     */
    PEER1_HALFCLOSE_WRITE_FAIL,

    /**
     * Peer1 read shutdown; Peer2 should get stream shutdown error during write
     */
    PEER1_READ_SHUTDOWN,

    /**
     * All tests successfully finished
     */
    SUCCESS
  };

/**
 * Current running test
 */
enum Test current_test;

/**
 * Input processor
 *
 * @param cls the closure from GNUNET_STREAM_write/read
 * @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);


/**
 * The transition function; responsible for the transitions among tests
 */
static void
transition();


/**
 * Task for calling STREAM_read
 *
 * @param cls the peer data entity
 * @param tc the task context
 */
static void
stream_read_task (void *cls,
                  const struct GNUNET_SCHEDULER_TaskContext *tc)
{
  struct PeerData *peer = cls;
  
  peer->io_read_handle = GNUNET_STREAM_read (peer->socket,
                                             GNUNET_TIME_relative_multiply
                                             (GNUNET_TIME_UNIT_SECONDS, 5),
                                             &input_processor,
                                             cls);
  switch (current_test)
    {
    case PEER1_WRITE_SHUTDOWN:
      GNUNET_assert (&peer2 == peer);
      GNUNET_assert (NULL == peer->io_read_handle);
      transition ();            /* to PEER1_HALFCLOSE_READ */
      break;
    default:
      GNUNET_assert (NULL != peer->io_read_handle);
    }
}


/**
 * 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);


/**
 * Task for calling STREAM_write
 *
 * @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;
  
  peer->io_write_handle = 
    GNUNET_STREAM_write (peer->socket,
                         (void *) data,
                         strlen(data) - peer->bytes_wrote,
                         GNUNET_TIME_relative_multiply
                         (GNUNET_TIME_UNIT_SECONDS, 5),
                         &write_completion,
                         peer);
  switch (current_test)
    {
    case PEER1_HALFCLOSE_WRITE_FAIL:
      GNUNET_assert (&peer1 == peer);
      GNUNET_assert (NULL == peer->io_write_handle);
      transition();             /* To PEER1_READ_SHUTDOWN */
      break;
    case PEER1_READ_SHUTDOWN:
      GNUNET_assert (&peer2 == peer);
      GNUNET_assert (NULL == peer->io_write_handle);
      transition ();            /* To SUCCESS */
      break;
    default:
        GNUNET_assert (NULL != peer->io_write_handle);
    }
}


/**
 * Check whether peers successfully shut down.
 */
static void
peergroup_shutdown_callback (void *cls, const char *emsg)
{
  if (emsg != NULL)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                "Shutdown of peers failed!\n");
  }
  else
  {
    GNUNET_log (GNUNET_ERROR_TYPE_INFO,
                "All peers successfully shut down!\n");
  }
  GNUNET_CONFIGURATION_destroy (config);
}


/**
 * Close sockets and stop testing deamons nicely
 */
static void
do_close (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
{
  if (NULL != peer1.socket)
    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);

  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: Wait\n");

  GNUNET_TESTING_daemons_stop (pg,
                               GNUNET_TIME_relative_multiply
                               (GNUNET_TIME_UNIT_SECONDS, 5),
                               &peergroup_shutdown_callback,
                               NULL);
}


/**
 * Completion callback for shutdown
 *
 * @param cls the closure from GNUNET_STREAM_shutdown call
 * @param operation the operation that was shutdown (SHUT_RD, SHUT_WR,
 *          SHUT_RDWR) 
 */
void 
shutdown_completion (void *cls,
                     int operation)
{
  switch (current_test)
    {
    case PEER1_WRITE:
      GNUNET_assert (0);
    case PEER1_WRITE_SHUTDOWN:
      GNUNET_assert (cls == &peer1);
      GNUNET_assert (SHUT_WR == operation);
      peer1.test_ok = GNUNET_YES;
      /* Peer2 should read with error */
      peer2.bytes_read = 0;
      GNUNET_SCHEDULER_add_now (&stream_read_task, &peer2);
      break;
    case PEER1_READ_SHUTDOWN:
      peer1.test_ok = GNUNET_YES;
      peer2.bytes_wrote = 0;
      GNUNET_SCHEDULER_add_now (&stream_write_task, &peer2);
      break;
    case PEER1_HALFCLOSE_READ:
    case PEER1_HALFCLOSE_WRITE_FAIL:
    case SUCCESS:
      GNUNET_assert (0);        /* We shouldn't reach here */
    }
}


/**
 * Task for calling STREAM_shutdown
 *
 * @param cls the peer entity
 * @param tc the TaskContext
 */
static void
stream_shutdown_task (void *cls,
                      const struct GNUNET_SCHEDULER_TaskContext *tc)
{
  struct PeerData *peer = cls;

  peer->shutdown_handle = GNUNET_STREAM_shutdown (peer->socket,
                                                  peer->shutdown_operation,
                                                  &shutdown_completion,
                                                  peer);
  GNUNET_assert (NULL != peer->shutdown_handle);
}


/**
 * 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 != read_task)
    {
      GNUNET_SCHEDULER_cancel (read_task);
    }
  result = GNUNET_SYSERR;
  abort_task = 0;
  do_close (cls, tc);  
}


/**
 * The transition function; responsible for the transitions among tests
 */
static void
transition()
{
  if ((GNUNET_YES == peer1.test_ok) && (GNUNET_YES == peer2.test_ok))
    {
      peer1.test_ok = GNUNET_NO;
      peer2.test_ok = GNUNET_NO;
      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                  "TEST %d SUCCESSFULL\n", current_test);
      switch (current_test)
        {
        case PEER1_WRITE:
          current_test = PEER1_WRITE_SHUTDOWN;
          /* Peer1 should shutdown writing */
          peer1.shutdown_operation = SHUT_WR;
          GNUNET_SCHEDULER_add_now (&stream_shutdown_task, &peer1);
          break;
        case PEER1_WRITE_SHUTDOWN:
          current_test = PEER1_HALFCLOSE_READ;
          /* Peer2 should be able to write successfully */
          peer2.bytes_wrote = 0;
          GNUNET_SCHEDULER_add_now (&stream_write_task, &peer2);
          
          /* Peer1 should be able to read successfully */
          peer1.bytes_read = 0;
          GNUNET_SCHEDULER_add_now (&stream_read_task, &peer1);
          break;
        case PEER1_HALFCLOSE_READ:
          current_test = PEER1_HALFCLOSE_WRITE_FAIL;
          peer1.bytes_wrote = 0;
          peer2.bytes_read = 0;
          peer2.test_ok = GNUNET_YES;
          GNUNET_SCHEDULER_add_now (&stream_write_task, &peer1);
          break;
        case PEER1_HALFCLOSE_WRITE_FAIL:
          current_test = PEER1_READ_SHUTDOWN;
          peer1.shutdown_operation = SHUT_RD;
          GNUNET_SCHEDULER_add_now (&stream_shutdown_task, &peer1);
          break;
        case PEER1_READ_SHUTDOWN:
          current_test = SUCCESS;
          GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                      "All tests successful\n");
          GNUNET_SCHEDULER_add_now (&do_close, NULL);
          break;
        case SUCCESS:
          GNUNET_assert (0);    /* We shouldn't reach here */
          
        }
    }
}

/**
 * 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 = cls;

  switch (current_test)
    {
    case PEER1_WRITE:
    case PEER1_HALFCLOSE_READ:

    GNUNET_assert (GNUNET_STREAM_OK == status);
    GNUNET_assert (size <= strlen (data));
    peer->bytes_wrote += size;

    if (peer->bytes_wrote < strlen(data)) /* Have more data to send */
      {
        GNUNET_SCHEDULER_add_now (&stream_write_task, peer);
      }
    else
      {
        GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                    "Writing completed\n");

        if (&peer1 == peer)
          {
            peer1.test_ok = GNUNET_YES;
            transition ();       /* to PEER1_WRITE_SHUTDOWN */
          }
        else            /* This will happen during PEER1_HALFCLOSE_READ */
          {
            peer2.test_ok = GNUNET_YES;
            transition ();      /* to PEER1_HALFCLOSE_WRITE_FAIL */
          }
      }
    break;
    case PEER1_HALFCLOSE_WRITE_FAIL:
      GNUNET_assert (peer == &peer1);
      GNUNET_assert (GNUNET_STREAM_SHUTDOWN == status);
      GNUNET_assert (0 == size);
      peer1.test_ok = GNUNET_YES;
      break;
    case PEER1_READ_SHUTDOWN:
      GNUNET_assert (peer == &peer2);
      GNUNET_assert (GNUNET_STREAM_SHUTDOWN == status);
      GNUNET_assert (0 == size);
      peer2.test_ok = GNUNET_YES;
      break;
    case PEER1_WRITE_SHUTDOWN:
    case SUCCESS:
      GNUNET_assert (0);        /* We shouldn't reach here */
    } 
}


/**
 * 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_assert (socket == peer1.socket);
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "%s: Stream established from peer1\n",
              GNUNET_i2s (&peer1.our_id));
  peer = (struct PeerData *) cls;
  peer->bytes_wrote = 0;
  GNUNET_assert (socket == peer1.socket);
  GNUNET_assert (socket == peer->socket);
  peer1.test_ok = GNUNET_NO;
  peer2.test_ok = GNUNET_NO;
  current_test = PEER1_WRITE;
  GNUNET_SCHEDULER_add_now (&stream_write_task, peer);
}


/**
 * Input processor
 *
 * @param cls the closure from GNUNET_STREAM_write/read
 * @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;

  peer = (struct PeerData *) cls;

  switch (current_test)
    {
    case PEER1_WRITE:
    case PEER1_HALFCLOSE_READ:
      if (GNUNET_STREAM_TIMEOUT == status)
        {
          GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                      "Read operation timedout - reading again!\n");
          GNUNET_assert (0 == size);
          GNUNET_SCHEDULER_add_now (&stream_read_task, peer);
          return 0;
        }

      GNUNET_assert (GNUNET_STREAM_OK == status);
      GNUNET_assert (size <= strlen (data));
      GNUNET_assert (0 == strncmp ((const char *) data + peer->bytes_read,
                                   (const char *) input_data,
                                   size));
      peer->bytes_read += size;
  
      if (peer->bytes_read < strlen (data))
        {
          GNUNET_SCHEDULER_add_now (&stream_read_task, peer);
        }
      else  
        {
          if (&peer2 == peer) /* Peer2 has completed reading; should write */
            {
              peer2.test_ok = GNUNET_YES;
              transition ();    /* Transition to PEER1_WRITE_SHUTDOWN */
            }
          else         /* Peer1 has completed reading. End of tests */
            {
              peer1.test_ok = GNUNET_YES;
              transition ();    /* to PEER1_HALFCLOSE_WRITE_FAIL */
            }
        }
      break;
    case PEER1_WRITE_SHUTDOWN:
      GNUNET_assert (GNUNET_STREAM_SHUTDOWN == status);
      peer2.test_ok = GNUNET_YES;
      break;
    case PEER1_HALFCLOSE_WRITE_FAIL:
    case PEER1_READ_SHUTDOWN:
    case SUCCESS:
      GNUNET_assert (0);        /* We shouldn't reach here */
    }
  
  return size;
}

  
/**
 * Scheduler call back; to be executed when a new stream is connected
 * Called from listen connect for peer2
 */
static void
stream_read (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
{
  read_task = GNUNET_SCHEDULER_NO_TASK;
  GNUNET_assert (NULL != cls);
  peer2.bytes_read = 0;
  GNUNET_SCHEDULER_add_now (&stream_read_task, &peer2);
}


/**
 * 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 (NULL != initiator);
  GNUNET_assert (socket != peer1.socket);

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "%s: Peer connected: %s\n",
              GNUNET_i2s (&peer2.our_id),
              GNUNET_i2s(initiator));

  peer2.socket = socket;
  /* FIXME: reading should be done right now instead of a scheduled call */
  read_task = GNUNET_SCHEDULER_add_now (&stream_read, (void *) socket);
  return GNUNET_OK;
}


/**
 * Callback to be called when testing peer group is ready
 *
 * @param cls NULL
 * @param emsg NULL on success
 */
void
peergroup_ready (void *cls, const char *emsg)
{
  if (NULL != emsg)
    {
      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                  "Starting peer group failed: %s\n", emsg);
      return;
    }
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Peer group is now ready\n");
  
  GNUNET_assert (2 == GNUNET_TESTING_daemons_running (pg));
  
  d1 = GNUNET_TESTING_daemon_get (pg, 0);
  GNUNET_assert (NULL != d1);
  
  d2 = GNUNET_TESTING_daemon_get (pg, 1);
  GNUNET_assert (NULL != d2);

  GNUNET_TESTING_get_peer_identity (d1->cfg,
                                    &peer1.our_id);
  GNUNET_TESTING_get_peer_identity (d2->cfg,
                                    &peer2.our_id);
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "%s : %s\n",
              GNUNET_i2s (&peer1.our_id),
              GNUNET_i2s (&d1->id));
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "%s : %s\n",
              GNUNET_i2s (&peer2.our_id),
              GNUNET_i2s (&d2->id));

  peer2_listen_socket = GNUNET_STREAM_listen (d2->cfg,
                                              10, /* App port */
                                              &stream_listen_cb,
                                              NULL);
  GNUNET_assert (NULL != peer2_listen_socket);

  /* Connect to stream library */
  peer1.socket = GNUNET_STREAM_open (d1->cfg,
                                     &d2->id,         /* Null for local peer? */
                                     10,           /* App port */
                                     &stream_open_cb,
                                     &peer1,
				     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)
{
  struct GNUNET_TESTING_Host *hosts; /* FIXME: free hosts (DLL) */

  /* GNUNET_log_setup ("test_stream_local", */
  /*                   "DEBUG", */
  /*                   NULL); */

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Starting test\n");
  /* Duplicate the configuration */
  config = GNUNET_CONFIGURATION_dup (cfg);

  hosts = GNUNET_TESTING_hosts_load (config);
  
  pg = GNUNET_TESTING_peergroup_start (config,
                                       2,
                                       GNUNET_TIME_relative_multiply
                                       (GNUNET_TIME_UNIT_SECONDS, 3),
                                       NULL,
                                       &peergroup_ready,
                                       NULL,
                                       hosts);
  GNUNET_assert (NULL != pg);
                                       
  abort_task =
    GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
                                  (GNUNET_TIME_UNIT_SECONDS, 40), &do_abort,
                                  NULL);
}

/**
 * Main function
 */
int main (int argc, char **argv)
{
  int ret;

  char *argv2[] = { "test-stream-2peers-halfclose",
                    "-L", "DEBUG",
                    "-c", "test_stream_local.conf",
                    NULL};
  
  struct GNUNET_GETOPT_CommandLineOption options[] = {
    GNUNET_GETOPT_OPTION_END
  };

  ret =
      GNUNET_PROGRAM_run ((sizeof (argv2) / sizeof (char *)) - 1, argv2,
                          "test-stream-2peers-halfclose", "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_INFO, "test ok\n");
  return 0;
}