src/core/test_core_quota_compliance.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 core/test_core_quota_compliance.c
  22  * @brief testcase for core_api.c focusing quota compliance on core level
  23  *
  24  * FIXME:
  25  * - make sure connect callback is invoked properly as well!
  26  */
  27 #include "platform.h"
  28 #include "gnunet_common.h"
  29 #include "gnunet_constants.h"
  30 #include "gnunet_arm_service.h"
  31 #include "gnunet_core_service.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_transport_service.h"
  37
  38 #define VERBOSE GNUNET_YES
  39 #define DEBUG_TRANSMISSION GNUNET_YES
  40
  41 #define START_ARM GNUNET_YES
  42
  43 /**
  44  * Note that this value must not significantly exceed
  45  * 'MAX_PENDING' in 'gnunet-service-transport.c', otherwise
  46  * messages may be dropped even for a reliable transport.
  47  */
  48 #define TOTAL_MSGS (60000 * 10)
  49
  50 /**
  51  * How long until we give up on transmitting the message?
  52  */
  53 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
  54
  55 /**
  56  * What delay do we request from the core service for transmission?
  57  * Any value smaller than the CORK delay will disable CORKing, which
  58  * is what we want here.
  59  */
  60 #define FAST_TIMEOUT GNUNET_TIME_relative_divide (GNUNET_CONSTANTS_MAX_CORK_DELAY, 2)
  61
  62 #define MTYPE 12345
  63 #define MSIZE 1024
  64 #define MEASUREMENT_LENGTH GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
  65
  66 static unsigned long long total_bytes_sent;
  67 static unsigned long long total_bytes_recv;
  68
  69 static struct GNUNET_TIME_Absolute start_time;
  70
  71 static GNUNET_SCHEDULER_TaskIdentifier err_task;
  72
  73 static GNUNET_SCHEDULER_TaskIdentifier measure_task;
  74
  75
  76 struct PeerContext
  77 {
  78   struct GNUNET_CONFIGURATION_Handle *cfg;
  79   struct GNUNET_CORE_Handle *ch;
  80   struct GNUNET_PeerIdentity id;
  81   struct GNUNET_TRANSPORT_Handle *th;
  82   struct GNUNET_MessageHeader *hello;
  83   int connect_status;
  84 #if START_ARM
  85   struct GNUNET_OS_Process *arm_proc;
  86 #endif
  87 };
  88
  89 static struct PeerContext p1;
  90 static struct PeerContext p2;
  91
  92 static unsigned long long current_quota_p1_in;
  93 static unsigned long long current_quota_p1_out;
  94 static unsigned long long current_quota_p2_in;
  95 static unsigned long long current_quota_p2_out;
  96
  97 static int ok;
  98
  99 static int32_t tr_n;
 100
 101 static int running;
 102
 103
 104 #if VERBOSE
 105 #define OKPP do { ok++; fprintf (stderr, "Now at stage %u at %s:%u\n", ok, __FILE__, __LINE__); } while (0)
 106 #else
 107 #define OKPP do { ok++; } while (0)
 108 #endif
 109
 110 struct TestMessage
 111 {
 112   struct GNUNET_MessageHeader header;
 113   uint32_t num;
 114 };
 115
 116 static void
 117 terminate_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 118 {
 119   GNUNET_CORE_disconnect (p1.ch);
 120   p1.ch = NULL;
 121   GNUNET_CORE_disconnect (p2.ch);
 122   p2.ch = NULL;
 123   GNUNET_TRANSPORT_disconnect (p1.th);
 124   p1.th = NULL;
 125   GNUNET_TRANSPORT_disconnect (p2.th);
 126   p2.th = NULL;
 127 }
 128
 129
 130 static void
 131 terminate_task_error (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 132 {
 133   GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Testcase timout, exit!\n");
 134   GNUNET_break (0);
 135
 136   if (measure_task != GNUNET_SCHEDULER_NO_TASK)
 137           GNUNET_SCHEDULER_cancel(measure_task);
 138
 139   GNUNET_CORE_disconnect (p1.ch);
 140   p1.ch = NULL;
 141   GNUNET_CORE_disconnect (p2.ch);
 142   p2.ch = NULL;
 143   GNUNET_TRANSPORT_disconnect (p1.th);
 144   p1.th = NULL;
 145   GNUNET_TRANSPORT_disconnect (p2.th);
 146   p2.th = NULL;
 147   ok = 42;
 148 }
 149
 150 static void
 151 measurement_stop (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 152 {
 153   unsigned long long int delta;
 154   unsigned long long int throughput_out;
 155   unsigned long long int throughput_int;
 156   unsigned long long int max_quota_in;
 157   unsigned long long int max_quota_out;
 158   unsigned long long int quota_delta;
 159
 160   measure_task = GNUNET_SCHEDULER_NO_TASK;
 161   fprintf(stdout,"\n");
 162   running = GNUNET_NO;
 163
 164   delta = GNUNET_TIME_absolute_get_duration (start_time).rel_value;
 165
 166   throughput_out = total_bytes_sent * 1000 / 1024 / delta;
 167   throughput_int = total_bytes_recv * 1000 / 1024 / delta;
 168
 169   if (current_quota_p1_in < current_quota_p2_in)
 170           max_quota_in = current_quota_p1_in;
 171   else
 172           max_quota_in = current_quota_p2_in;
 173   if (current_quota_p1_out < current_quota_p2_out)
 174           max_quota_out = current_quota_p1_out;
 175   else
 176           max_quota_out = current_quota_p2_out;
 177
 178   if (max_quota_out < max_quota_in)
 179           quota_delta = max_quota_in / 10;
 180   else
 181           quota_delta = max_quota_out / 10;
 182
 183   if ((throughput_out < (max_quota_out/1024)) && (throughput_out < (max_quota_in/1024)))
 184   {
 185           ok = 0;
 186   }
 187   else
 188   {
 189           ok = 1;
 190   }
 191   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Bytes in: %llu Bytes\n",total_bytes_recv);
 192   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Throughput in: %llu kb/s\n",throughput_out);
 193   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Max. inbound quota allowed: %llu kb/s\n",max_quota_in/1024);
 194
 195   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Bytes out: %llu Bytes\n",total_bytes_sent);
 196   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Throughput out: %llu kb/s\n",throughput_out);
 197   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Max. outbound quota allowed: %llu kb/s\n",max_quota_out/1024);
 198
 199   GNUNET_SCHEDULER_cancel (err_task);
 200   GNUNET_SCHEDULER_add_now (&terminate_task, NULL);
 201
 202 }
 203
 204 static size_t
 205 transmit_ready (void *cls, size_t size, void *buf)
 206 {
 207   char *cbuf = buf;
 208   struct TestMessage hdr;
 209   unsigned int ret;
 210
 211   GNUNET_assert (size <= GNUNET_CONSTANTS_MAX_ENCRYPTED_MESSAGE_SIZE);
 212   if (buf == NULL)
 213     {
 214       if (p1.ch != NULL)
 215         GNUNET_break (NULL !=
 216                       GNUNET_CORE_notify_transmit_ready (p1.ch,
 217                                                          0,
 218                                                          FAST_TIMEOUT,
 219                                                          &p2.id,
 220                                                          MSIZE,
 221                                                          &transmit_ready, &p1));
 222       return 0;
 223     }
 224   GNUNET_assert (tr_n < TOTAL_MSGS);
 225   ret = 0;
 226   GNUNET_assert (size >= MSIZE);
 227   GNUNET_assert (buf != NULL);
 228   cbuf = buf;
 229   do
 230     {
 231 #if DEBUG_TRANSMISSION
 232       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 233                   "Sending message %u of size %u at offset %u\n",
 234                   tr_n,
 235                   MSIZE,
 236                   ret);
 237 #endif
 238       hdr.header.size = htons (MSIZE);
 239       hdr.header.type = htons (MTYPE);
 240       hdr.num = htonl (tr_n);
 241       memcpy (&cbuf[ret], &hdr, sizeof (struct TestMessage));
 242       ret += sizeof (struct TestMessage);
 243       memset (&cbuf[ret], tr_n, MSIZE - sizeof (struct TestMessage));
 244       ret += MSIZE - sizeof (struct TestMessage);
 245       tr_n++;
 246       if (0 == GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 16))
 247         break; /* sometimes pack buffer full, sometimes not */
 248     }
 249   while (size - ret >= MSIZE);
 250   GNUNET_SCHEDULER_cancel (err_task);
 251   err_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT,
 252                                   &terminate_task_error,
 253                                   NULL);
 254
 255   total_bytes_sent += ret;
 256   return ret;
 257 }
 258
 259
 260
 261 static void
 262 connect_notify (void *cls,
 263                 const struct GNUNET_PeerIdentity *peer,
 264                 const struct GNUNET_TRANSPORT_ATS_Information *atsi)
 265 {
 266   struct PeerContext *pc = cls;
 267
 268   GNUNET_assert (pc->connect_status == 0);
 269   pc->connect_status = 1;
 270   if (pc == &p1)
 271     {
 272 #if DEBUG_TRANSMISSION
 273       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 274                   "Encrypted connection established to peer `%4s'\n",
 275                   GNUNET_i2s (peer));
 276       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 277                   "Asking core (1) for transmission to peer `%4s'\n",
 278                   GNUNET_i2s (&p2.id));
 279 #endif
 280       err_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT,
 281                                       &terminate_task_error,
 282                                       NULL);
 283       start_time = GNUNET_TIME_absolute_get ();
 284       running = GNUNET_YES;
 285       measure_task = GNUNET_SCHEDULER_add_delayed(MEASUREMENT_LENGTH, &measurement_stop, NULL);
 286
 287       GNUNET_break (NULL != GNUNET_CORE_notify_transmit_ready (p1.ch,
 288                                                        0,
 289                                                        TIMEOUT,
 290                                                        &p2.id,
 291                                                        MSIZE,
 292                                                        &transmit_ready, &p1));
 293     }
 294 }
 295
 296
 297 static void
 298 disconnect_notify (void *cls,
 299                    const struct GNUNET_PeerIdentity *peer)
 300 {
 301   struct PeerContext *pc = cls;
 302   pc->connect_status = 0;
 303 #if DEBUG_TRANSMISSION
 304   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 305               "Encrypted connection to `%4s' cut\n", GNUNET_i2s (peer));
 306 #endif
 307 }
 308
 309
 310 static int
 311 inbound_notify (void *cls,
 312                 const struct GNUNET_PeerIdentity *other,
 313                 const struct GNUNET_MessageHeader *message,
 314                 const struct GNUNET_TRANSPORT_ATS_Information *atsi)
 315 {
 316 #if DEBUG_TRANSMISSION
 317   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 318               "Core provides inbound data from `%4s' %llu.\n", GNUNET_i2s (other), ntohs(message->size));
 319 #endif
 320   total_bytes_recv += ntohs(message->size);
 321   return GNUNET_OK;
 322 }
 323
 324
 325 static int
 326 outbound_notify (void *cls,
 327                  const struct GNUNET_PeerIdentity *other,
 328                  const struct GNUNET_MessageHeader *message,
 329                  const struct GNUNET_TRANSPORT_ATS_Information *atsi)
 330 {
 331 #if DEBUG_TRANSMISSION
 332   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 333               "Core notifies about outbound data for `%4s'.\n",
 334               GNUNET_i2s (other));
 335 #endif
 336   return GNUNET_OK;
 337 }
 338
 339
 340 static size_t
 341 transmit_ready (void *cls, size_t size, void *buf);
 342
 343 static int
 344 process_mtype (void *cls,
 345                const struct GNUNET_PeerIdentity *peer,
 346                const struct GNUNET_MessageHeader *message,
 347                const struct GNUNET_TRANSPORT_ATS_Information *atsi)
 348 {
 349   static int n;
 350   const struct TestMessage *hdr;
 351
 352   hdr = (const struct TestMessage*) message;
 353   if (MTYPE != ntohs (message->type))
 354     return GNUNET_SYSERR;
 355   if (ntohs (message->size) != MSIZE)
 356     {
 357       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 358                   "Expected message %u of size %u, got %u bytes of message %u\n",
 359                   n, MSIZE,
 360                   ntohs (message->size),
 361                   ntohl (hdr->num));
 362       GNUNET_SCHEDULER_cancel (err_task);
 363       err_task = GNUNET_SCHEDULER_add_now (&terminate_task_error, NULL);
 364       return GNUNET_SYSERR;
 365     }
 366   if (ntohl (hdr->num) != n)
 367     {
 368       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 369                   "Expected message %u of size %u, got %u bytes of message %u\n",
 370                   n, MSIZE,
 371                   ntohs (message->size),
 372                   ntohl (hdr->num));
 373       GNUNET_SCHEDULER_cancel (err_task);
 374       err_task = GNUNET_SCHEDULER_add_now (&terminate_task_error, NULL);
 375       return GNUNET_SYSERR;
 376     }
 377 #if DEBUG_TRANSMISSION
 378   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 379               "Got message %u of size %u\n",
 380               ntohl (hdr->num),
 381               ntohs (message->size));
 382 #endif
 383   n++;
 384   if (0 == (n % (TOTAL_MSGS/100)))
 385     fprintf (stderr, ".");
 386   if (n == TOTAL_MSGS)
 387     {
 388       GNUNET_SCHEDULER_cancel (err_task);
 389       GNUNET_SCHEDULER_add_now (&terminate_task, NULL);
 390     }
 391   else
 392     {
 393       if (running == GNUNET_YES)
 394         GNUNET_break (NULL !=
 395                       GNUNET_CORE_notify_transmit_ready (p1.ch,
 396                                                          0,
 397                                                          FAST_TIMEOUT,
 398                                                          &p2.id,
 399                                                          MSIZE,
 400                                                          &transmit_ready, &p1));
 401     }
 402   return GNUNET_OK;
 403 }
 404
 405
 406 static struct GNUNET_CORE_MessageHandler handlers[] = {
 407   {&process_mtype, MTYPE, 0},
 408   {NULL, 0, 0}
 409 };
 410
 411
 412
 413 static void
 414 init_notify (void *cls,
 415              struct GNUNET_CORE_Handle *server,
 416              const struct GNUNET_PeerIdentity *my_identity,
 417              const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *publicKey)
 418 {
 419   struct PeerContext *p = cls;
 420
 421   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 422               "Connection to CORE service of `%4s' established\n",
 423               GNUNET_i2s (my_identity));
 424   GNUNET_assert (server != NULL);
 425   p->id = *my_identity;
 426   p->ch = server;
 427   if (cls == &p1)
 428     {
 429       GNUNET_assert (ok == 2);
 430       OKPP;
 431       /* connect p2 */
 432       GNUNET_CORE_connect (p2.cfg, 1,
 433                            &p2,
 434                            &init_notify,
 435                            &connect_notify,
 436                            &disconnect_notify,
 437                            NULL,
 438                            &inbound_notify,
 439                            GNUNET_YES,
 440                            &outbound_notify, GNUNET_YES, handlers);
 441     }
 442   else
 443     {
 444       GNUNET_assert (ok == 3);
 445       OKPP;
 446       GNUNET_assert (cls == &p2);
 447 #if DEBUG_TRANSMISSION
 448       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 449                   "Asking core (1) to connect to peer `%4s'\n",
 450                   GNUNET_i2s (&p2.id));
 451 #endif
 452       GNUNET_CORE_peer_request_connect (p1.ch,
 453                                         GNUNET_TIME_UNIT_SECONDS,
 454                                         &p2.id,
 455                                         NULL, NULL);
 456     }
 457 }
 458
 459
 460 static void
 461 process_hello (void *cls,
 462                const struct GNUNET_MessageHeader *message)
 463 {
 464   struct PeerContext *p = cls;
 465
 466   GNUNET_TRANSPORT_get_hello_cancel (p->th, &process_hello, p);
 467
 468 #if DEBUG_TRANSMISSION
 469   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 470               "Received (my) `%s' from transport service\n",
 471               "HELLO");
 472 #endif
 473   GNUNET_assert (message != NULL);
 474   p->hello = GNUNET_malloc (ntohs (message->size));
 475   memcpy (p->hello, message, ntohs (message->size));
 476   if ((p == &p1) && (p2.th != NULL))
 477     GNUNET_TRANSPORT_offer_hello (p2.th, message);
 478   if ((p == &p2) && (p1.th != NULL))
 479     GNUNET_TRANSPORT_offer_hello (p1.th, message);
 480
 481   if ((p == &p1) && (p2.hello != NULL))
 482     GNUNET_TRANSPORT_offer_hello (p1.th, p2.hello);
 483   if ((p == &p2) && (p1.hello != NULL))
 484     GNUNET_TRANSPORT_offer_hello (p2.th, p1.hello);
 485 }
 486
 487
 488
 489 static void
 490 setup_peer (struct PeerContext *p, const char *cfgname)
 491 {
 492   p->cfg = GNUNET_CONFIGURATION_create ();
 493 #if START_ARM
 494   p->arm_proc = GNUNET_OS_start_process (NULL, NULL, "gnunet-service-arm",
 495                                         "gnunet-service-arm",
 496 #if VERBOSE
 497                                         "-L", "DEBUG",
 498 #endif
 499                                         "-c", cfgname, NULL);
 500 #endif
 501   GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_load (p->cfg, cfgname));
 502   p->th = GNUNET_TRANSPORT_connect (p->cfg, NULL, p, NULL, NULL, NULL);
 503   GNUNET_assert (p->th != NULL);
 504   GNUNET_TRANSPORT_get_hello (p->th, &process_hello, p);
 505 }
 506
 507
 508 static void
 509 run (void *cls,
 510      char *const *args,
 511      const char *cfgfile,
 512      const struct GNUNET_CONFIGURATION_Handle *cfg)
 513 {
 514   GNUNET_assert (ok == 1);
 515   OKPP;
 516   setup_peer (&p1, "test_core_quota_peer1.conf");
 517   setup_peer (&p2, "test_core_quota_peer2.conf");
 518
 519   GNUNET_assert (GNUNET_SYSERR != GNUNET_CONFIGURATION_get_value_number (p1.cfg,
 520                                          "CORE",
 521                                          "TOTAL_QUOTA_IN",
 522                                          &current_quota_p1_in));
 523   GNUNET_assert (GNUNET_SYSERR != GNUNET_CONFIGURATION_get_value_number (p2.cfg,
 524                                          "CORE",
 525                                          "TOTAL_QUOTA_IN",
 526                                          &current_quota_p2_in));
 527   GNUNET_assert (GNUNET_SYSERR != GNUNET_CONFIGURATION_get_value_number (p1.cfg,
 528                                          "CORE",
 529                                          "TOTAL_QUOTA_OUT",
 530                                          &current_quota_p1_out));
 531   GNUNET_assert (GNUNET_SYSERR != GNUNET_CONFIGURATION_get_value_number (p2.cfg,
 532                                          "CORE",
 533                                          "TOTAL_QUOTA_OUT",
 534                                          &current_quota_p2_out));
 535
 536   GNUNET_CORE_connect (p1.cfg, 1,
 537                        &p1,
 538                        &init_notify,
 539                        &connect_notify,
 540                        &disconnect_notify,
 541                        NULL,
 542                        &inbound_notify,
 543                        GNUNET_YES, &outbound_notify, GNUNET_YES, handlers);
 544 }
 545
 546
 547 static void
 548 stop_arm (struct PeerContext *p)
 549 {
 550 #if START_ARM
 551   if (0 != GNUNET_OS_process_kill (p->arm_proc, SIGTERM))
 552     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
 553   if (GNUNET_OS_process_wait(p->arm_proc) != GNUNET_OK)
 554     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "waitpid");
 555   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 556               "ARM process %u stopped\n", GNUNET_OS_process_get_pid (p->arm_proc));
 557   GNUNET_OS_process_close (p->arm_proc);
 558   p->arm_proc = NULL;
 559 #endif
 560   GNUNET_CONFIGURATION_destroy (p->cfg);
 561 }
 562
 563 static int
 564 check ()
 565 {
 566   char *const argv[] = { "test-core-quota-compliance",
 567     "-c",
 568     "test_core_api_data.conf",
 569 #if VERBOSE
 570     "-L", "DEBUG",
 571 #endif
 572     NULL
 573   };
 574   struct GNUNET_GETOPT_CommandLineOption options[] = {
 575     GNUNET_GETOPT_OPTION_END
 576   };
 577   ok = 1;
 578   GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1,
 579                       argv, "test-core-quota-compliance", "nohelp", options, &run, &ok);
 580   stop_arm (&p1);
 581   stop_arm (&p2);
 582   return ok;
 583 }
 584
 585 int
 586 main (int argc, char *argv[])
 587 {
 588   int ret;
 589
 590   GNUNET_log_setup ("test-core-quota-compliance",
 591 #if VERBOSE
 592                     "DEBUG",
 593 #else
 594                     "WARNING",
 595 #endif
 596                     NULL);
 597   ret = check ();
 598   GNUNET_DISK_directory_remove ("/tmp/test-gnunet-core-peer-1");
 599   GNUNET_DISK_directory_remove ("/tmp/test-gnunet-core-peer-2");
 600
 601   return ret;
 602 }
 603 /* end of test_core_api_reliability.c */