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