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