src/core/test_core_api_reliability.c

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