src/stream/test_stream_sequence_wraparound.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2011, 2012 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 stream/test_stream_sequence_wraparound.c
  23  * @brief test cases for sequence wrap around situations during data transfer
  24  * @author Sree Harsha Totakura
  25  */
  26
  27 #include <string.h>
  28
  29 #include "platform.h"
  30 #include "gnunet_util_lib.h"
  31 #include "gnunet_stream_lib.h"
  32 #include "gnunet_testing_lib-new.h"
  33
  34 /**
  35  * Generic logging shorthand
  36  */
  37 #define LOG(kind, ...)                         \
  38   GNUNET_log (kind, __VA_ARGS__);
  39
  40 /**
  41  * Relative seconds shorthand
  42  */
  43 #define TIME_REL_SECS(sec) \
  44   GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, sec)
  45
  46 /**
  47  * Structure for holding peer's sockets and IO Handles
  48  */
  49 struct PeerData
  50 {
  51   /**
  52    * Peer's stream socket
  53    */
  54   struct GNUNET_STREAM_Socket *socket;
  55
  56   /**
  57    * Peer's io write handle
  58    */
  59   struct GNUNET_STREAM_IOWriteHandle *io_write_handle;
  60
  61   /**
  62    * Peer's io read handle
  63    */
  64   struct GNUNET_STREAM_IOReadHandle *io_read_handle;
  65
  66   /**
  67    * Bytes the peer has written
  68    */
  69   unsigned int bytes_wrote;
  70
  71   /**
  72    * Byte the peer has read
  73    */
  74   unsigned int bytes_read;
  75 };
  76
  77 static struct PeerData peer1;
  78 static struct PeerData peer2;
  79 static struct GNUNET_STREAM_ListenSocket *peer2_listen_socket;
  80 static const struct GNUNET_CONFIGURATION_Handle *config;
  81 static struct GNUNET_TESTING_Peer *self;
  82 static struct GNUNET_PeerIdentity self_id;
  83
  84 static GNUNET_SCHEDULER_TaskIdentifier abort_task;
  85 static GNUNET_SCHEDULER_TaskIdentifier read_task;
  86 static GNUNET_SCHEDULER_TaskIdentifier write_task;
  87
  88 #define DATA_SIZE 65536      /* 64KB */
  89 static uint32_t data[DATA_SIZE / 4];     /* 64KB array */
  90 static int result;
  91
  92 /**
  93  * Shutdown nicely
  94  */
  95 static void
  96 do_shutdown (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
  97 {
  98   if (NULL != peer1.socket)
  99     GNUNET_STREAM_close (peer1.socket);
 100   if (NULL != peer2.socket)
 101     GNUNET_STREAM_close (peer2.socket);
 102   if (NULL != peer2_listen_socket)
 103     GNUNET_STREAM_listen_close (peer2_listen_socket); /* Close listen socket */
 104   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: shutdown\n");
 105   if (0 != abort_task)
 106   {
 107     GNUNET_SCHEDULER_cancel (abort_task);
 108   }
 109 }
 110
 111
 112 /**
 113  * Something went wrong and timed out. Kill everything and set error flag
 114  */
 115 static void
 116 do_abort (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 117 {
 118   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: ABORT\n");
 119   if (GNUNET_SCHEDULER_NO_TASK != read_task)
 120     {
 121       GNUNET_SCHEDULER_cancel (read_task);
 122     }
 123   result = GNUNET_SYSERR;
 124   abort_task = 0;
 125   do_shutdown (cls, tc);
 126 }
 127
 128
 129 /**
 130  * The write completion function; called upon writing some data to stream or
 131  * upon error
 132  *
 133  * @param cls the closure from GNUNET_STREAM_write/read
 134  * @param status the status of the stream at the time this function is called
 135  * @param size the number of bytes read or written
 136  */
 137 static void
 138 write_completion (void *cls,
 139                   enum GNUNET_STREAM_Status status,
 140                   size_t size)
 141 {
 142   struct PeerData *peer;
 143
 144   peer = (struct PeerData *) cls;
 145   GNUNET_assert (GNUNET_STREAM_OK == status);
 146   GNUNET_assert (size <= DATA_SIZE);
 147   peer->bytes_wrote += size;
 148
 149   if (peer->bytes_wrote < DATA_SIZE) /* Have more data to send */
 150     {
 151       peer->io_write_handle =
 152         GNUNET_STREAM_write (peer->socket,
 153                              ((void *) data) + peer->bytes_wrote,
 154                              DATA_SIZE - peer->bytes_wrote,
 155                              GNUNET_TIME_relative_multiply
 156                              (GNUNET_TIME_UNIT_SECONDS, 5),
 157                              &write_completion,
 158                              cls);
 159       GNUNET_assert (NULL != peer->io_write_handle);
 160     }
 161   else
 162     {
 163       LOG (GNUNET_ERROR_TYPE_DEBUG, "Writing successfully finished\n");
 164       result = GNUNET_OK;
 165       GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
 166     }
 167 }
 168
 169
 170 /**
 171  * Task for calling STREAM_write with a chunk of random data
 172  *
 173  * @param cls the peer data entity
 174  * @param tc the task context
 175  */
 176 static void
 177 stream_write_task (void *cls,
 178                    const struct GNUNET_SCHEDULER_TaskContext *tc)
 179 {
 180   struct PeerData *peer=cls;
 181   unsigned int count;
 182
 183   write_task = GNUNET_SCHEDULER_NO_TASK;
 184   for (count=0; count < DATA_SIZE / 4; count++)
 185     {
 186       data[count]=GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
 187                                             UINT32_MAX);
 188     }
 189   LOG (GNUNET_ERROR_TYPE_DEBUG, "Generation of random data complete\n");
 190   peer->io_write_handle = GNUNET_STREAM_write (peer->socket,
 191                                                data,
 192                                                DATA_SIZE,
 193                                                GNUNET_TIME_relative_multiply
 194                                                (GNUNET_TIME_UNIT_SECONDS, 10),
 195                                                &write_completion,
 196                                                peer);
 197   GNUNET_assert (NULL != peer->io_write_handle);
 198 }
 199
 200
 201 /**
 202  * Function executed after stream has been established
 203  *
 204  * @param cls the closure from GNUNET_STREAM_open
 205  * @param socket socket to use to communicate with the other side (read/write)
 206  */
 207 static void
 208 stream_open_cb (void *cls,
 209                 struct GNUNET_STREAM_Socket *socket)
 210 {
 211   struct PeerData *peer;
 212
 213   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Stream established from peer1\n");
 214   peer = (struct PeerData *) cls;
 215   peer->bytes_wrote = 0;
 216   GNUNET_assert (socket == peer1.socket);
 217   GNUNET_assert (socket == peer->socket);
 218   write_task = GNUNET_SCHEDULER_add_now (&stream_write_task, peer);
 219 }
 220
 221
 222 /**
 223  * Scheduler call back; to be executed when a new stream is connected
 224  * Called from listen connect for peer2
 225  */
 226 static void
 227 stream_read_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
 228
 229
 230 /**
 231  * Input processor
 232  *
 233  * @param cls peer2
 234  * @param status the status of the stream at the time this function is called
 235  * @param data traffic from the other side
 236  * @param size the number of bytes available in data read
 237  * @return number of bytes of processed from 'data' (any data remaining should be
 238  *         given to the next time the read processor is called).
 239  */
 240 static size_t
 241 input_processor (void *cls,
 242                  enum GNUNET_STREAM_Status status,
 243                  const void *input_data,
 244                  size_t size)
 245 {
 246   struct PeerData *peer = cls;
 247
 248   GNUNET_assert (GNUNET_STREAM_OK == status);
 249   GNUNET_assert (&peer2 == peer);
 250   GNUNET_assert (size < DATA_SIZE);
 251   GNUNET_assert (0 == memcmp (((void *)data ) + peer->bytes_read,
 252                               input_data, size));
 253   peer->bytes_read += size;
 254
 255   if (peer->bytes_read < DATA_SIZE)
 256   {
 257     GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == read_task);
 258     read_task = GNUNET_SCHEDULER_add_now (&stream_read_task, &peer2);
 259   }
 260   else
 261   {
 262     /* Peer2 has completed reading*/
 263     LOG (GNUNET_ERROR_TYPE_DEBUG, "Reading finished successfully\n");
 264   }
 265   return size;
 266 }
 267
 268
 269 /**
 270  * Scheduler call back; to be executed when a new stream is connected
 271  * Called from listen connect for peer2
 272  */
 273 static void
 274 stream_read_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 275 {
 276   struct PeerData *peer = cls;
 277
 278   read_task = GNUNET_SCHEDULER_NO_TASK;
 279   GNUNET_assert (&peer2 == peer);
 280   peer->io_read_handle =
 281     GNUNET_STREAM_read (peer->socket,
 282                         GNUNET_TIME_relative_multiply
 283                         (GNUNET_TIME_UNIT_SECONDS, 10),
 284                         &input_processor,
 285                         peer);
 286   GNUNET_assert (NULL != peer->io_read_handle);
 287 }
 288
 289
 290 /**
 291  * Functions of this type are called upon new stream connection from other peers
 292  *
 293  * @param cls the closure from GNUNET_STREAM_listen
 294  * @param socket the socket representing the stream
 295  * @param initiator the identity of the peer who wants to establish a stream
 296  *            with us
 297  * @return GNUNET_OK to keep the socket open, GNUNET_SYSERR to close the
 298  *             stream (the socket will be invalid after the call)
 299  */
 300 static int
 301 stream_listen_cb (void *cls,
 302            struct GNUNET_STREAM_Socket *socket,
 303            const struct GNUNET_PeerIdentity *initiator)
 304 {
 305   if ((NULL == socket) || (NULL == initiator))
 306   {
 307     GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Binding error\n");
 308     if (GNUNET_SCHEDULER_NO_TASK != abort_task)
 309       GNUNET_SCHEDULER_cancel (abort_task);
 310     abort_task = GNUNET_SCHEDULER_add_now (&do_abort, NULL);
 311     return GNUNET_OK;
 312   }
 313   GNUNET_assert (NULL != socket);
 314   GNUNET_assert (socket != peer1.socket);
 315   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 316               "Peer connected: %s\n", GNUNET_i2s(initiator));
 317   peer2.socket = socket;
 318   peer2.bytes_read = 0;
 319   read_task = GNUNET_SCHEDULER_add_now (&stream_read_task, &peer2);
 320   return GNUNET_OK;
 321 }
 322
 323
 324 /**
 325  * Listen success callback; connects a peer to stream as client
 326  */
 327 static void
 328 stream_connect (void)
 329 {
 330   peer1.socket =
 331     GNUNET_STREAM_open (config,
 332                         &self_id,         /* Null for local peer? */
 333                         10,           /* App port */
 334                         &stream_open_cb,
 335                         &peer1,
 336                         GNUNET_STREAM_OPTION_TESTING_SET_WRITE_SEQUENCE_NUMBER,
 337                         UINT32_MAX - GNUNET_CRYPTO_random_u32
 338                         (GNUNET_CRYPTO_QUALITY_WEAK, 64),
 339                         GNUNET_STREAM_OPTION_MAX_PAYLOAD_SIZE, 500,
 340                         GNUNET_STREAM_OPTION_END);
 341   GNUNET_assert (NULL != peer1.socket);
 342 }
 343
 344
 345 /**
 346  * Initialize framework and start test
 347  */
 348 static void
 349 run (void *cls,
 350      const struct GNUNET_CONFIGURATION_Handle *cfg,
 351      struct GNUNET_TESTING_Peer *peer)
 352 {
 353   config = cfg;
 354   self = peer;
 355   (void) GNUNET_TESTING_peer_get_identity (peer, &self_id);
 356   peer2_listen_socket =
 357     GNUNET_STREAM_listen (config,
 358                           10, /* App port */
 359                           &stream_listen_cb,
 360                           NULL,
 361                           GNUNET_STREAM_OPTION_LISTEN_TIMEOUT,
 362                           60 * 1000,
 363                           GNUNET_STREAM_OPTION_SIGNAL_LISTEN_SUCCESS,
 364                           &stream_connect,
 365                           GNUNET_STREAM_OPTION_END);
 366   GNUNET_assert (NULL != peer2_listen_socket);
 367   abort_task =
 368     GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
 369                                   (GNUNET_TIME_UNIT_SECONDS, 100), &do_abort,
 370                                   NULL);
 371 }
 372
 373
 374 /**
 375  * Main function
 376  */
 377 int main (int argc, char **argv)
 378 {
 379   if (0 != GNUNET_TESTING_peer_run ("test_stream_sequence_wraparound",
 380                                     "test_stream_local.conf",
 381                                     &run, NULL))
 382     return 1;
 383   return (GNUNET_SYSERR == result) ? 1 : 0;
 384 }
 385
 386 /* end of test_stream_sequence_wraparound.c */