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