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