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