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