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