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