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