src/transport/test_transport_api_unreliability_constant.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009, 2010 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  * @file transport/test_transport_api_unreliability_constant.c
  22  * @brief test case for transports; ensures messages get
  23  *        through, regardless of order, constant packet size
  24  *
  25  * This test case serves as a base for unreliable
  26  * transport test cases to check that the transports
  27  * achieve reliable message delivery.
  28  */
  29 #include "platform.h"
  30 #include "gnunet_common.h"
  31 #include "gnunet_hello_lib.h"
  32 #include "gnunet_getopt_lib.h"
  33 #include "gnunet_os_lib.h"
  34 #include "gnunet_program_lib.h"
  35 #include "gnunet_scheduler_lib.h"
  36 #include "gnunet_server_lib.h"
  37 #include "gnunet_transport_service.h"
  38 #include "gauger.h"
  39 #include "transport.h"
  40 #include "transport-testing.h"
  41
  42 #define VERBOSE GNUNET_EXTRA_LOGGING
  43
  44 #define VERBOSE_ARM GNUNET_EXTRA_LOGGING
  45
  46 #define START_ARM GNUNET_YES
  47
  48 /**
  49  * Testcase timeout
  50  */
  51 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 900)
  52
  53 /**
  54  * How long until we give up on transmitting the message?
  55  */
  56 #define TIMEOUT_TRANSMIT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 60)
  57
  58 static char *test_source;
  59
  60 static char *test_plugin;
  61
  62 static char *test_name;
  63
  64 static int ok;
  65
  66 static GNUNET_SCHEDULER_TaskIdentifier die_task;
  67
  68 struct PeerContext *p1;
  69
  70 struct PeerContext *p2;
  71
  72 struct GNUNET_TRANSPORT_TransmitHandle *th;
  73
  74 struct GNUNET_TRANSPORT_TESTING_handle * tth;
  75
  76 char *cfg_file_p1;
  77
  78 char *cfg_file_p2;
  79
  80 uint32_t max_bps_p1;
  81 uint32_t max_bps_p2;
  82
  83 static GNUNET_TRANSPORT_TESTING_ConnectRequest cc;
  84
  85 /*
  86  * Testcase specific declarations
  87  */
  88
  89 /**
  90  * Note that this value must not significantly exceed
  91  * 'MAX_PENDING' in 'gnunet-service-transport.c', otherwise
  92  * messages may be dropped even for a reliable transport.
  93  */
  94 #define TOTAL_MSGS (1024 * 3)
  95
  96 #define MTYPE 12345
  97
  98 #define MSG_SIZE 10000
  99
 100 struct TestMessage
 101 {
 102   struct GNUNET_MessageHeader header;
 103   uint32_t num;
 104 };
 105
 106 static char *test_name;
 107
 108 static int msg_scheduled;
 109 static int msg_sent;
 110 static int msg_recv_expected;
 111 static int msg_recv;
 112
 113 static int test_failed;
 114
 115 static unsigned long long total_bytes;
 116
 117 static struct GNUNET_TIME_Absolute start_time;
 118
 119 /*
 120  * END Testcase specific declarations
 121  */
 122
 123 #if VERBOSE
 124 #define OKPP do { ok++; fprintf (stderr, "Now at stage %u at %s:%u\n", ok, __FILE__, __LINE__); } while (0)
 125 #else
 126 #define OKPP do { ok++; } while (0)
 127 #endif
 128
 129 int
 130 get_bit (const char *map, unsigned int bit);
 131
 132 static void
 133 end ()
 134 {
 135   unsigned long long delta;
 136
 137   char *value_name;
 138
 139   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Stopping peers\n");
 140
 141   delta = GNUNET_TIME_absolute_get_duration (start_time).rel_value;
 142   fprintf (stderr, "\nThroughput was %llu kb/s\n",
 143            total_bytes * 1000 / 1024 / delta);
 144   GNUNET_asprintf (&value_name, "unreliable_%s", test_plugin);
 145   GAUGER ("TRANSPORT", value_name, (int) (total_bytes * 1000 / 1024 / delta),
 146           "kb/s");
 147   GNUNET_free (value_name);
 148
 149   if (die_task != GNUNET_SCHEDULER_NO_TASK)
 150     GNUNET_SCHEDULER_cancel (die_task);
 151
 152   if (th != NULL)
 153     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
 154   th = NULL;
 155
 156   if (cc != NULL)
 157     GNUNET_TRANSPORT_TESTING_connect_peers_cancel(tth, cc);
 158   cc = NULL;
 159
 160   GNUNET_TRANSPORT_TESTING_stop_peer (tth, p1);
 161   GNUNET_TRANSPORT_TESTING_stop_peer (tth, p2);
 162
 163   GNUNET_TRANSPORT_TESTING_done (tth);
 164
 165   ok = 0;
 166   if (test_failed == GNUNET_NO)
 167     ok = GNUNET_SYSERR;
 168   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "GOT %u of %u messages\n", msg_recv, TOTAL_MSGS);
 169 }
 170
 171 static void
 172 end_badly ()
 173 {
 174   die_task = GNUNET_SCHEDULER_NO_TASK;
 175   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Fail! Stopping peers\n");
 176
 177   if (test_failed == GNUNET_NO)
 178     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Testcase timeout\n");
 179   else
 180     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 181                 "Reliability failed: Last message sent %u, Next message scheduled %u, Last message received %u, Message expected %u\n",
 182                 msg_sent, msg_scheduled, msg_recv, msg_recv_expected);
 183
 184   if (th != NULL)
 185     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
 186   th = NULL;
 187
 188   if (cc != NULL)
 189     GNUNET_TRANSPORT_TESTING_connect_peers_cancel(tth, cc);
 190   cc = NULL;
 191
 192   if (p1 != NULL)
 193     GNUNET_TRANSPORT_TESTING_stop_peer (tth, p1);
 194   if (p2 != NULL)
 195     GNUNET_TRANSPORT_TESTING_stop_peer (tth, p2);
 196
 197   GNUNET_TRANSPORT_TESTING_done (tth);
 198
 199   ok = GNUNET_SYSERR;
 200 }
 201
 202
 203 static unsigned int
 204 get_size (unsigned int iter)
 205 {
 206 /*
 207   unsigned int ret;
 208   ret = (iter * iter * iter);
 209   return sizeof (struct TestMessage) + (ret % 60000);
 210   */
 211   return MSG_SIZE;
 212 }
 213
 214
 215
 216
 217 static void
 218 notify_receive (void *cls, const struct GNUNET_PeerIdentity *peer,
 219                 const struct GNUNET_MessageHeader *message,
 220                 const struct GNUNET_ATS_Information *ats,
 221                 uint32_t ats_count)
 222 {
 223   static int n;
 224
 225   unsigned int s;
 226   char cbuf[GNUNET_SERVER_MAX_MESSAGE_SIZE - 1];
 227   const struct TestMessage *hdr;
 228
 229   hdr = (const struct TestMessage *) message;
 230
 231   if (MTYPE != ntohs (message->type))
 232     return;
 233   msg_recv_expected = n;
 234   msg_recv = ntohl (hdr->num);
 235   if (msg_recv_expected != msg_recv)
 236   {
 237     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 238                 "Expected message no %u, got %u\n",
 239                 msg_recv_expected, msg_recv);
 240     if (GNUNET_SCHEDULER_NO_TASK != die_task)
 241       GNUNET_SCHEDULER_cancel (die_task);
 242     test_failed = GNUNET_YES;
 243     die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
 244     return;
 245   }
 246
 247   s = get_size (ntohl (hdr->num));
 248   if (ntohs (message->size) != s)
 249   {
 250     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 251                 "Expected message %u of size %u, got %u bytes of message %u\n",
 252                 ntohl (hdr->num), s, ntohs (message->size), ntohl (hdr->num));
 253     if (GNUNET_SCHEDULER_NO_TASK != die_task)
 254       GNUNET_SCHEDULER_cancel (die_task);
 255     test_failed = GNUNET_YES;
 256     die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
 257     return;
 258   }
 259
 260   memset (cbuf, ntohl (hdr->num), s - sizeof (struct TestMessage));
 261   if (0 != memcmp (cbuf, &hdr[1], s - sizeof (struct TestMessage)))
 262   {
 263     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 264                 "Expected message %u with bits %u, but body did not match\n",
 265                 ntohl (hdr->num), (unsigned char) n);
 266     if (GNUNET_SCHEDULER_NO_TASK != die_task)
 267       GNUNET_SCHEDULER_cancel (die_task);
 268     test_failed = GNUNET_YES;
 269     die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
 270     return;
 271   }
 272 #if VERBOSE
 273   if (ntohl (hdr->num) % 5 == 0)
 274   {
 275     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got message %u of size %u\n",
 276                 ntohl (hdr->num), ntohs (message->size));
 277   }
 278 #endif
 279   n++;
 280   if (0 == (n % (TOTAL_MSGS / 100)))
 281   {
 282     fprintf (stderr, ".");
 283     if (GNUNET_SCHEDULER_NO_TASK != die_task)
 284       GNUNET_SCHEDULER_cancel (die_task);
 285     test_failed = GNUNET_YES;
 286     die_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly, NULL);
 287   }
 288   if (n == TOTAL_MSGS)
 289   {
 290     /* because of starting with 0 */
 291     msg_recv++;
 292     fprintf (stderr, "\n");
 293     end ();
 294   }
 295 }
 296
 297
 298 static size_t
 299 notify_ready (void *cls, size_t size, void *buf)
 300 {
 301   static int n;
 302   char *cbuf = buf;
 303   struct TestMessage hdr;
 304   unsigned int s;
 305   unsigned int ret;
 306
 307   th = NULL;
 308
 309   if (buf == NULL)
 310   {
 311     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 312                 "Timeout occurred while waiting for transmit_ready\n");
 313     if (GNUNET_SCHEDULER_NO_TASK != die_task)
 314       GNUNET_SCHEDULER_cancel (die_task);
 315     die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
 316     ok = 42;
 317     return 0;
 318   }
 319   ret = 0;
 320   s = get_size (n);
 321   GNUNET_assert (size >= s);
 322   GNUNET_assert (buf != NULL);
 323   cbuf = buf;
 324   do
 325   {
 326     hdr.header.size = htons (s);
 327     hdr.header.type = htons (MTYPE);
 328     hdr.num = htonl (n);
 329     msg_sent = n;
 330     memcpy (&cbuf[ret], &hdr, sizeof (struct TestMessage));
 331     ret += sizeof (struct TestMessage);
 332     memset (&cbuf[ret], n, s - sizeof (struct TestMessage));
 333     ret += s - sizeof (struct TestMessage);
 334 #if VERBOSE
 335     if (n % 1 == 0)
 336     {
 337       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Sending message %u of size %u\n", n,
 338                   s);
 339     }
 340
 341 #endif
 342     n++;
 343     s = get_size (n);
 344     if (0 == GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 16))
 345       break;                    /* sometimes pack buffer full, sometimes not */
 346   }
 347   while (size - ret >= s);
 348   if (n < TOTAL_MSGS)
 349   {
 350     th = GNUNET_TRANSPORT_notify_transmit_ready (p2->th, &p1->id, s, 0,
 351                                                  TIMEOUT_TRANSMIT,
 352                                                  &notify_ready, NULL);
 353     msg_scheduled = n;
 354   }
 355   else
 356   {
 357     fprintf (stderr, "\n");
 358     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 359                 "All messages scheduled to be sent!!\n");
 360     if (GNUNET_SCHEDULER_NO_TASK != die_task)
 361       GNUNET_SCHEDULER_cancel (die_task);
 362     die_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly, NULL);
 363   }
 364   if (n % 5000 == 0)
 365   {
 366     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 367                 "Returning total message block of size %u\n", ret);
 368   }
 369   total_bytes += ret;
 370   return ret;
 371 }
 372
 373
 374 static void
 375 notify_connect (void *cls, const struct GNUNET_PeerIdentity *peer,
 376                 const struct GNUNET_ATS_Information *ats,
 377                 uint32_t ats_count)
 378 {
 379
 380   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer `%4s' connected to us (%p)!\n",
 381               GNUNET_i2s (peer), cls);
 382 }
 383
 384
 385 static void
 386 notify_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
 387 {
 388   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer `%4s' disconnected (%p)!\n",
 389               GNUNET_i2s (peer), cls);
 390   if (th != NULL)
 391     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
 392   th = NULL;
 393 }
 394
 395 static void
 396 sendtask ()
 397 {
 398   start_time = GNUNET_TIME_absolute_get ();
 399   th = GNUNET_TRANSPORT_notify_transmit_ready (p2->th, &p1->id, get_size (0), 0,
 400                                                TIMEOUT_TRANSMIT, &notify_ready,
 401                                                NULL);
 402 }
 403
 404 static void
 405 testing_connect_cb (struct PeerContext *p1, struct PeerContext *p2, void *cls)
 406 {
 407   char *p1_c = strdup (GNUNET_i2s (&p1->id));
 408
 409   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peers connected: %s <-> %s\n", p1_c,
 410               GNUNET_i2s (&p2->id));
 411   GNUNET_free (p1_c);
 412
 413   cc = NULL;
 414
 415   GNUNET_SCHEDULER_add_now (&sendtask, NULL);
 416 }
 417
 418 void start_cb (struct PeerContext * p,
 419                void *cls)
 420 {
 421   static int started;
 422   started++;
 423
 424   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer %u (`%s') started\n",
 425        p->no,
 426        GNUNET_i2s (&p->id));
 427
 428   if (started != 2)
 429     return;
 430
 431   cc = GNUNET_TRANSPORT_TESTING_connect_peers (tth, p1, p2, &testing_connect_cb, NULL);
 432 }
 433
 434 static void
 435 run (void *cls, char *const *args, const char *cfgfile,
 436      const struct GNUNET_CONFIGURATION_Handle *cfg)
 437 {
 438   die_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly, NULL);
 439
 440   p1 = GNUNET_TRANSPORT_TESTING_start_peer (tth, cfg_file_p1, 1,
 441                                             &notify_receive,
 442                                             &notify_connect, &notify_disconnect,
 443                                             &start_cb,
 444                                             NULL);
 445   p2 = GNUNET_TRANSPORT_TESTING_start_peer (tth, cfg_file_p2, 2,
 446                                             &notify_receive,
 447                                             &notify_connect, &notify_disconnect,
 448                                             &start_cb,
 449                                             NULL);
 450
 451   if ((p1 == NULL) || (p2 == NULL))
 452   {
 453     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Fail! Could not start peers!\n");
 454     if (die_task != GNUNET_SCHEDULER_NO_TASK)
 455       GNUNET_SCHEDULER_cancel (die_task);
 456     die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
 457     return;
 458   }
 459 }
 460
 461 static int
 462 check ()
 463 {
 464   static char *const argv[] = { "test-transport-api-unreliability-constant",
 465     "-c",
 466     "test_transport_api_data.conf",
 467 #if VERBOSE
 468     "-L", "DEBUG",
 469 #endif
 470     NULL
 471   };
 472   static struct GNUNET_GETOPT_CommandLineOption options[] = {
 473     GNUNET_GETOPT_OPTION_END
 474   };
 475
 476 #if WRITECONFIG
 477   setTransportOptions ("test_transport_api_data.conf");
 478 #endif
 479   ok = GNUNET_SYSERR;
 480
 481   GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1, argv, test_name,
 482                       "nohelp", options, &run, &ok);
 483
 484   return ok;
 485 }
 486
 487 int
 488 main (int argc, char *argv[])
 489 {
 490   int ret;
 491   int nat_res;
 492
 493   tth = GNUNET_TRANSPORT_TESTING_init ();
 494
 495   GNUNET_TRANSPORT_TESTING_get_test_source_name (__FILE__, &test_source);
 496   GNUNET_TRANSPORT_TESTING_get_test_plugin_name (argv[0], test_source,
 497                                                  &test_plugin);
 498   GNUNET_TRANSPORT_TESTING_get_test_name (argv[0], &test_name);
 499
 500   GNUNET_log_setup (test_name,
 501 #if VERBOSE
 502                     "DEBUG",
 503 #else
 504                     "WARNING",
 505 #endif
 506                     NULL);
 507
 508   if ((strcmp (test_plugin, "tcp_nat") == 0) ||
 509       (strcmp (test_plugin, "udp_nat") == 0))
 510   {
 511     nat_res = GNUNET_OS_check_helper_binary ("gnunet-nat-server");
 512     if (GNUNET_NO == nat_res)
 513     {
 514       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Cannot run NAT test: `%s' %s \n",
 515                   "gnunet-nat-server", "SUID not set");
 516       return 0;
 517     }
 518     if (GNUNET_SYSERR == nat_res)
 519     {
 520       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Cannot run NAT test: `%s' %s \n",
 521                   "gnunet-nat-server", "file not found");
 522       return 0;
 523     }
 524   }
 525
 526   GNUNET_TRANSPORT_TESTING_get_config_name (argv[0], &cfg_file_p1, 1);
 527   GNUNET_TRANSPORT_TESTING_get_config_name (argv[0], &cfg_file_p2, 2);
 528
 529   ret = check ();
 530
 531   GNUNET_free (cfg_file_p1);
 532   GNUNET_free (cfg_file_p2);
 533
 534   GNUNET_free (test_source);
 535   GNUNET_free (test_plugin);
 536   GNUNET_free (test_name);
 537
 538   return ret;
 539 }
 540
 541 /* end of test_transport_api_unreliability_constant.c */