src/transport/test_quota_compliance.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2009, 2010, 2011 GNUnet e.V.
   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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20 /**
  21  * @file transport/test_quota_compliance.c
  22  * @brief base test case for transport implementations
  23  *
  24  * This test case tests quota compliance both on transport level
  25  */
  26 #include "platform.h"
  27 #include "gnunet_transport_service.h"
  28 #include "gnunet_ats_service.h"
  29 #include "gauger.h"
  30 #include "transport-testing.h"
  31
  32 /**
  33  * Testcase timeout
  34  */
  35 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 120)
  36
  37 /**
  38  * How long until we give up on transmitting the message?
  39  */
  40 #define TIMEOUT_TRANSMIT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 20)
  41
  42 #define DURATION GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
  43
  44 static char *test_source;
  45
  46 static char *test_plugin;
  47
  48 static char *test_name;
  49
  50 static struct GNUNET_SCHEDULER_Task * die_task;
  51
  52 static struct GNUNET_SCHEDULER_Task * measure_task;
  53
  54 struct PeerContext *p1;
  55
  56 struct PeerContext *p2;
  57
  58 struct PeerContext *sender;
  59
  60 struct PeerContext *receiver;
  61
  62 struct GNUNET_TRANSPORT_TransmitHandle *th;
  63
  64 char *cfg_file_p1;
  65 char *gen_cfg_p2;
  66 unsigned long long quota_in_p1;
  67 unsigned long long quota_out_p1;
  68
  69 char *cfg_file_p2;
  70 char *gen_cfg_p1;
  71 unsigned long long quota_in_p2;
  72 unsigned long long quota_out_p2;
  73
  74 struct GNUNET_TRANSPORT_TESTING_handle *tth;
  75
  76 static struct GNUNET_TRANSPORT_TESTING_ConnectRequest * cc;
  77
  78
  79 /*
  80  * Testcase specific declarations
  81  */
  82
  83 /**
  84  * Note that this value must not significantly exceed
  85  * 'MAX_PENDING' in 'gnunet-service-transport.c', otherwise
  86  * messages may be dropped even for a reliable transport.
  87  */
  88 #define TOTAL_MSGS (1024 * 2)
  89
  90 #define MTYPE 12345
  91
  92 GNUNET_NETWORK_STRUCT_BEGIN
  93 struct TestMessage
  94 {
  95   struct GNUNET_MessageHeader header;
  96   uint32_t num;
  97 };
  98 GNUNET_NETWORK_STRUCT_END
  99
 100 static int msg_scheduled;
 101 static int msg_sent;
 102
 103 static int test_failed;
 104 static int test_connected;
 105
 106 static unsigned long long total_bytes_sent;
 107
 108 static struct GNUNET_TIME_Absolute start_time;
 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
 121 static void
 122 end ()
 123 {
 124   unsigned long long delta;
 125   unsigned long long datarate;
 126
 127   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Stopping peers\n");
 128
 129   delta = GNUNET_TIME_absolute_get_duration (start_time).rel_value_us;
 130   datarate = (total_bytes_sent * 1000 * 1000) / delta;
 131
 132   FPRINTF (stderr, "Throughput was %llu b/s\n", datarate);
 133
 134   test_failed = GNUNET_NO;
 135   if (datarate > quota_in_p2)
 136   {
 137     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 138                 "Datarate of %llu b/s higher than allowed inbound quota of %llu b/s\n",
 139                 datarate, quota_in_p2);
 140     test_failed = GNUNET_YES;
 141   }
 142   if (datarate > quota_out_p1)
 143   {
 144     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 145                 "Datarate of %llu b/s higher than allowed outbound quota of %llu b/s\n",
 146                 datarate, quota_out_p1);
 147     test_failed = GNUNET_YES;
 148   }
 149   if (test_failed == GNUNET_NO)
 150   {
 151     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 152                 "Datarate of %llu b/s complied to allowed outbound quota of %llu b/s and inbound quota of %llu b/s\n",
 153                 datarate, quota_out_p1, quota_in_p2);
 154   }
 155
 156   if (die_task != NULL)
 157     GNUNET_SCHEDULER_cancel (die_task);
 158
 159   if (th != NULL)
 160     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
 161   th = NULL;
 162
 163   if (cc != NULL)
 164     GNUNET_TRANSPORT_TESTING_connect_peers_cancel (tth, cc);
 165
 166   GNUNET_TRANSPORT_TESTING_stop_peer (tth, p1);
 167   GNUNET_TRANSPORT_TESTING_stop_peer (tth, p2);
 168
 169 }
 170
 171 static void
 172 end_badly ()
 173 {
 174   die_task = NULL;
 175   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Fail! Stopping peers\n");
 176
 177   if (measure_task != NULL)
 178     GNUNET_SCHEDULER_cancel (measure_task);
 179
 180   if (test_connected == GNUNET_YES)
 181     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Peers got connected\n");
 182   else
 183     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Peers got NOT connected\n");
 184
 185   if (th != NULL)
 186     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
 187   th = NULL;
 188
 189   if (cc != NULL)
 190     GNUNET_TRANSPORT_TESTING_connect_peers_cancel (tth, cc);
 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   test_failed = GNUNET_YES;
 198 }
 199
 200
 201 static unsigned int
 202 get_size (unsigned int iter)
 203 {
 204   unsigned int ret;
 205
 206   ret = (iter * iter * iter);
 207   return sizeof (struct TestMessage) + (ret % 60000);
 208 }
 209
 210
 211 static void
 212 notify_receive (void *cls,
 213                 const struct GNUNET_PeerIdentity *peer,
 214                 const struct GNUNET_MessageHeader *message)
 215 {
 216   const struct TestMessage *hdr;
 217   struct PeerContext *p = cls;
 218
 219   hdr = (const struct TestMessage *) message;
 220   if (MTYPE != ntohs (message->type))
 221     return;
 222
 223   {
 224     char *ps = GNUNET_strdup (GNUNET_i2s (&p->id));
 225
 226     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 227                 "Peer %u (`%s') got message %u of size %u from peer (`%s')\n",
 228                 p->no,
 229                 ps,
 230                 ntohl (hdr->num),
 231                 ntohs (message->size),
 232                 GNUNET_i2s (peer));
 233     GNUNET_free (ps);
 234   }
 235 }
 236
 237
 238 static size_t
 239 notify_ready (void *cls, size_t size, void *buf)
 240 {
 241   static int n;
 242   char *cbuf = buf;
 243   struct TestMessage hdr;
 244   unsigned int s;
 245   unsigned int ret;
 246
 247   th = NULL;
 248   if (buf == NULL)
 249   {
 250     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 251                 "Timeout occurred while waiting for transmit_ready for message %u of %u\n",
 252                 msg_scheduled, TOTAL_MSGS);
 253     if (NULL != die_task)
 254       GNUNET_SCHEDULER_cancel (die_task);
 255     die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
 256     test_failed = 1;
 257     return 0;
 258   }
 259
 260   ret = 0;
 261   s = get_size (n);
 262   GNUNET_assert (size >= s);
 263   GNUNET_assert (buf != NULL);
 264   cbuf = buf;
 265   do
 266   {
 267     hdr.header.size = htons (s);
 268     hdr.header.type = htons (MTYPE);
 269     hdr.num = htonl (n);
 270     msg_sent = n;
 271     memcpy (&cbuf[ret], &hdr, sizeof (struct TestMessage));
 272     ret += sizeof (struct TestMessage);
 273     memset (&cbuf[ret], n, s - sizeof (struct TestMessage));
 274     ret += s - sizeof (struct TestMessage);
 275 #if VERBOSE
 276     if (n % 5000 == 0)
 277     {
 278 #endif
 279       char *receiver_s = GNUNET_strdup (GNUNET_i2s (&receiver->id));
 280
 281       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 282                   "Sending message %u of size %u from peer %u (`%4s') -> peer %u (`%s') !\n",
 283                   n, s, sender->no, GNUNET_i2s (&sender->id), receiver->no,
 284                   receiver_s);
 285       GNUNET_free (receiver_s);
 286 #if 0
 287     }
 288 #endif
 289     n++;
 290     s = get_size (n);
 291     if (0 == GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 16))
 292       break;                    /* sometimes pack buffer full, sometimes not */
 293   }
 294   while (size - ret >= s);
 295   if (n < TOTAL_MSGS)
 296   {
 297     if (th == NULL)
 298       th = GNUNET_TRANSPORT_notify_transmit_ready (p2->th, &p1->id, s,
 299                                                    TIMEOUT_TRANSMIT,
 300                                                    &notify_ready, NULL);
 301     msg_scheduled = n;
 302   }
 303   if (n % 5000 == 0)
 304   {
 305     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 306                 "Returning total message block of size %u\n", ret);
 307   }
 308   total_bytes_sent += ret;
 309   if (n == TOTAL_MSGS)
 310   {
 311     FPRINTF (stderr, "%s",  "\n");
 312     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "All messages sent\n");
 313   }
 314   return ret;
 315 }
 316
 317
 318 static void
 319 notify_connect (void *cls, const struct GNUNET_PeerIdentity *peer)
 320 {
 321
 322   struct PeerContext *p = cls;
 323
 324   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 325               "Peer %u (`%4s') connected to us!\n",
 326               p->no,
 327               GNUNET_i2s (peer));
 328 }
 329
 330
 331 static void
 332 notify_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
 333 {
 334   struct PeerContext *p = cls;
 335
 336   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 337               "Peer %u (`%4s') disconnected!\n",
 338               p->no,
 339               GNUNET_i2s (peer));
 340   if (th != NULL)
 341     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
 342   th = NULL;
 343
 344 }
 345
 346 static void
 347 sendtask ()
 348 {
 349   start_time = GNUNET_TIME_absolute_get ();
 350   th = GNUNET_TRANSPORT_notify_transmit_ready (p2->th, &p1->id, get_size (0),
 351                                                TIMEOUT_TRANSMIT, &notify_ready,
 352                                                NULL);
 353 }
 354
 355
 356 static void
 357 measure (void *cls)
 358 {
 359   static int counter;
 360
 361   measure_task = NULL;
 362
 363   counter++;
 364   if ((DURATION.rel_value_us / 1000 / 1000LL) < counter)
 365   {
 366     FPRINTF (stderr, "%s",  ".\n");
 367     GNUNET_SCHEDULER_add_now (&end, NULL);
 368   }
 369   else
 370   {
 371     FPRINTF (stderr, "%s",  ".");
 372     measure_task =
 373         GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS, &measure, NULL);
 374   }
 375 }
 376
 377
 378 static void
 379 testing_connect_cb (struct PeerContext *p1, struct PeerContext *p2, void *cls)
 380 {
 381   char *p1_c = GNUNET_strdup (GNUNET_i2s (&p1->id));
 382
 383   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peers connected: %u (%s) <-> %u (%s)\n",
 384               p1->no, p1_c, p2->no, GNUNET_i2s (&p2->id));
 385   GNUNET_free (p1_c);
 386
 387   cc = NULL;
 388   test_connected = GNUNET_YES;
 389
 390   measure_task =
 391       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS, &measure, NULL);
 392   GNUNET_SCHEDULER_add_now (&sendtask, NULL);
 393
 394 }
 395
 396 void
 397 start_cb (struct PeerContext *p, void *cls)
 398 {
 399   static int started;
 400
 401   started++;
 402
 403   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer %u (`%s') started\n", p->no,
 404               GNUNET_i2s (&p->id));
 405
 406   if (started != 2)
 407     return;
 408
 409   test_connected = GNUNET_NO;
 410
 411   sender = p2;
 412   receiver = p1;
 413
 414   char *sender_c = GNUNET_strdup (GNUNET_i2s (&sender->id));
 415   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 416               "Test tries to send from %u (%s) -> peer %u (%s)\n", sender->no,
 417               sender_c, receiver->no, GNUNET_i2s (&receiver->id));
 418   GNUNET_free (sender_c);
 419   cc = GNUNET_TRANSPORT_TESTING_connect_peers (tth, p1, p2, &testing_connect_cb,
 420                                                NULL);
 421
 422 }
 423
 424 static char *
 425 generate_config (char *cfg_file, unsigned long long quota_in,
 426                  unsigned long long quota_out)
 427 {
 428   char *in_name;
 429   char *out_name;
 430   char *fname = NULL;
 431   struct GNUNET_CONFIGURATION_Handle *cfg = GNUNET_CONFIGURATION_create ();
 432   int c;
 433
 434   GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_load (cfg, cfg_file));
 435   GNUNET_asprintf (&fname, "q_in_%llu_q_out_%llu_%s", quota_in, quota_out,
 436                    cfg_file);
 437
 438   GNUNET_CONFIGURATION_set_value_string (cfg, "PATHS", "DEFAULTCONFIG", fname);
 439
 440   for (c = 0; c < GNUNET_ATS_NetworkTypeCount; c++)
 441   {
 442     GNUNET_asprintf (&in_name,
 443                      "%s_QUOTA_IN",
 444                      GNUNET_ATS_print_network_type (c));
 445     GNUNET_asprintf (&out_name,
 446                      "%s_QUOTA_OUT",
 447                      GNUNET_ATS_print_network_type (c));
 448     GNUNET_CONFIGURATION_set_value_number (cfg, "ats", in_name, quota_in);
 449     GNUNET_CONFIGURATION_set_value_number (cfg, "ats", out_name, quota_out);
 450     GNUNET_free (in_name);
 451     GNUNET_free (out_name);
 452   }
 453   GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_write (cfg, fname));
 454   GNUNET_CONFIGURATION_destroy (cfg);
 455   return fname;
 456 }
 457
 458 static void
 459 run_measurement (unsigned long long p1_quota_in,
 460                  unsigned long long p1_quota_out,
 461                  unsigned long long p2_quota_in,
 462                  unsigned long long p2_quota_out)
 463 {
 464   die_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly, NULL);
 465
 466   /* setting ATS quota */
 467   quota_out_p1 = p1_quota_out;
 468   gen_cfg_p1 = generate_config (cfg_file_p1, p1_quota_in, p1_quota_out);
 469   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Generated config file `%s'\n",
 470               gen_cfg_p1);
 471
 472   quota_in_p2 = p2_quota_in;
 473   gen_cfg_p2 = generate_config (cfg_file_p2, p2_quota_in, p2_quota_out);
 474   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Generated config file `%s'\n",
 475               gen_cfg_p2);
 476
 477   p1 = GNUNET_TRANSPORT_TESTING_start_peer (tth, gen_cfg_p1, 1, &notify_receive,
 478                                             &notify_connect, &notify_disconnect,
 479                                             &start_cb, NULL);
 480
 481   p2 = GNUNET_TRANSPORT_TESTING_start_peer (tth, gen_cfg_p2, 2, &notify_receive,
 482                                             &notify_connect, &notify_disconnect,
 483                                             &start_cb, NULL);
 484
 485   if ((p1 == NULL) || (p2 == NULL))
 486   {
 487     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Fail! Could not start peers!\n");
 488     if (die_task != NULL)
 489       GNUNET_SCHEDULER_cancel (die_task);
 490     die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
 491     return;
 492   }
 493 }
 494
 495 static void
 496 run (void *cls, char *const *args, const char *cfgfile,
 497      const struct GNUNET_CONFIGURATION_Handle *cfg)
 498 {
 499   unsigned long long p1_quota_in = 10000;
 500   unsigned long long p1_quota_out = 10000;
 501   unsigned long long p2_quota_in = 10000;
 502   unsigned long long p2_quota_out = 10000;
 503
 504   if (NULL != strstr (test_name, "asymmetric"))
 505   {
 506     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 507                 "Running asymmetric test with sending peer unlimited, receiving peer (in/out): %llu/%llu b/s \n",
 508                 p2_quota_in, p2_quota_out);
 509     p1_quota_out = 1024 * 1024 * 1024;
 510     p1_quota_in = 1024 * 1024 * 1024;
 511   }
 512   else
 513   {
 514     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 515                 "Running symmetric test with (in/out) %llu/%llu b/s \n",
 516                 p2_quota_in, p2_quota_out);
 517   }
 518   run_measurement (p1_quota_in, p1_quota_out, p2_quota_in, p2_quota_out);
 519 }
 520
 521 static int
 522 check ()
 523 {
 524   static char *argv[] = { "test_transport-quota-compliance",
 525     "-c",
 526     "test_quota_compliance_data.conf",
 527     NULL
 528   };
 529   static struct GNUNET_GETOPT_CommandLineOption options[] = {
 530     GNUNET_GETOPT_OPTION_END
 531   };
 532
 533   GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1, argv, test_name,
 534                       "nohelp", options, &run, NULL);
 535   return test_failed;
 536 }
 537
 538 int
 539 main (int argc, char *argv[])
 540 {
 541   GNUNET_TRANSPORT_TESTING_get_test_name (argv[0], &test_name);
 542
 543   GNUNET_log_setup (test_name,
 544                     "WARNING",
 545                     NULL);
 546
 547   GNUNET_TRANSPORT_TESTING_get_test_source_name (__FILE__, &test_source);
 548   GNUNET_TRANSPORT_TESTING_get_test_plugin_name (argv[0], test_source,
 549                                                  &test_plugin);
 550
 551   tth = GNUNET_TRANSPORT_TESTING_init ();
 552
 553   GNUNET_TRANSPORT_TESTING_get_config_name (argv[0], &cfg_file_p1, 1);
 554   GNUNET_TRANSPORT_TESTING_get_config_name (argv[0], &cfg_file_p2, 2);
 555
 556   check ();
 557
 558   GNUNET_free (cfg_file_p1);
 559   GNUNET_free (cfg_file_p2);
 560
 561   if (GNUNET_YES == GNUNET_DISK_file_test (gen_cfg_p1))
 562   {
 563     GNUNET_DISK_directory_remove (gen_cfg_p1);
 564     GNUNET_free (gen_cfg_p1);
 565   }
 566
 567   if (GNUNET_YES == GNUNET_DISK_file_test (gen_cfg_p2))
 568   {
 569     GNUNET_DISK_directory_remove (gen_cfg_p2);
 570     GNUNET_free (gen_cfg_p2);
 571   }
 572
 573   GNUNET_free (test_source);
 574   GNUNET_free (test_plugin);
 575   GNUNET_free (test_name);
 576
 577   GNUNET_TRANSPORT_TESTING_done (tth);
 578
 579   return test_failed;
 580 }
 581
 582
 583 /* end of test_quota_compliance.c */