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