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, 600)
  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 (NULL == buf)
 189   {
 190     if (NULL != p1.ch)
 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,
 225                                     &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 `%s'\n",
 246                 GNUNET_i2s (peer));
 247     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 248                 "Asking core (1) for transmission to peer `%s'\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,
 256                                                      GNUNET_CORE_PRIO_BEST_EFFORT,
 257                                                      TIMEOUT, &p2.id,
 258                                                      get_size (0),
 259                                                      &transmit_ready, &p1));
 260   }
 261 }
 262
 263
 264 static void
 265 disconnect_notify (void *cls, const struct GNUNET_PeerIdentity *peer)
 266 {
 267   struct PeerContext *pc = cls;
 268
 269   if (0 == memcmp (&pc->id, peer, sizeof (struct GNUNET_PeerIdentity)))
 270     return;
 271   pc->connect_status = 0;
 272   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Encrypted connection to `%s' cut\n",
 273               GNUNET_i2s (peer));
 274 }
 275
 276
 277 static int
 278 inbound_notify (void *cls, const struct GNUNET_PeerIdentity *other,
 279                 const struct GNUNET_MessageHeader *message)
 280 {
 281   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 282               "Core provides inbound data from `%s'.\n", GNUNET_i2s (other));
 283   return GNUNET_OK;
 284 }
 285
 286
 287 static int
 288 outbound_notify (void *cls, const struct GNUNET_PeerIdentity *other,
 289                  const struct GNUNET_MessageHeader *message)
 290 {
 291   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 292               "Core notifies about outbound data for `%s'.\n",
 293               GNUNET_i2s (other));
 294   return GNUNET_OK;
 295 }
 296
 297
 298 static size_t
 299 transmit_ready (void *cls, size_t size, void *buf);
 300
 301
 302 static int
 303 process_mtype (void *cls,
 304                const struct GNUNET_PeerIdentity *peer,
 305                const struct GNUNET_MessageHeader *message)
 306 {
 307   static int n;
 308   unsigned int s;
 309   const struct TestMessage *hdr;
 310
 311   hdr = (const struct TestMessage *) message;
 312   s = get_size (n);
 313   if (MTYPE != ntohs (message->type))
 314     return GNUNET_SYSERR;
 315   if (ntohs (message->size) != s)
 316   {
 317     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 318                 "Expected message %u of size %u, got %u bytes of message %u\n",
 319                 n, s, ntohs (message->size), ntohl (hdr->num));
 320     GNUNET_SCHEDULER_cancel (err_task);
 321     err_task = GNUNET_SCHEDULER_add_now (&terminate_task_error, NULL);
 322     return GNUNET_SYSERR;
 323   }
 324   if (ntohl (hdr->num) != n)
 325   {
 326     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 327                 "Expected message %u of size %u, got %u bytes of message %u\n",
 328                 n, s, ntohs (message->size), ntohl (hdr->num));
 329     GNUNET_SCHEDULER_cancel (err_task);
 330     err_task = GNUNET_SCHEDULER_add_now (&terminate_task_error, NULL);
 331     return GNUNET_SYSERR;
 332   }
 333   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got message %u of size %u\n",
 334               ntohl (hdr->num), ntohs (message->size));
 335   n++;
 336   if (0 == (n % (TOTAL_MSGS / 100)))
 337     FPRINTF (stderr, "%s",  ".");
 338   if (n == TOTAL_MSGS)
 339   {
 340     GNUNET_SCHEDULER_cancel (err_task);
 341     GNUNET_SCHEDULER_add_now (&terminate_task, NULL);
 342   }
 343   else
 344   {
 345     if (n == tr_n)
 346       GNUNET_break (NULL !=
 347                     GNUNET_CORE_notify_transmit_ready (p1.ch,
 348                                                        GNUNET_NO /* no cork */,
 349                                                        GNUNET_CORE_PRIO_BEST_EFFORT,
 350                                                        FAST_TIMEOUT /* ignored! */,
 351                                                        &p2.id,
 352                                                        get_size (tr_n),
 353                                                        &transmit_ready, &p1));
 354   }
 355   return GNUNET_OK;
 356 }
 357
 358
 359 static struct GNUNET_CORE_MessageHandler handlers[] = {
 360   {&process_mtype, MTYPE, 0},
 361   {NULL, 0, 0}
 362 };
 363
 364
 365 static void
 366 init_notify (void *cls,
 367              const struct GNUNET_PeerIdentity *my_identity)
 368 {
 369   struct PeerContext *p = cls;
 370
 371   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 372               "Connection to CORE service of `%s' established\n",
 373               GNUNET_i2s (my_identity));
 374   p->id = *my_identity;
 375   if (cls == &p1)
 376   {
 377     GNUNET_assert (ok == 2);
 378     OKPP;
 379     /* connect p2 */
 380     GNUNET_assert (NULL != (p2.ch = GNUNET_CORE_connect (p2.cfg, &p2,
 381                                                          &init_notify,
 382                                                          &connect_notify,
 383                                                          &disconnect_notify,
 384                                                          &inbound_notify, GNUNET_YES,
 385                                                          &outbound_notify, GNUNET_YES,
 386                                                          handlers)));
 387   }
 388   else
 389   {
 390     GNUNET_assert (ok == 3);
 391     OKPP;
 392     GNUNET_assert (cls == &p2);
 393     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 394                 "Asking transport (1) to connect to peer `%s'\n",
 395                 GNUNET_i2s (&p2.id));
 396     connect_task = GNUNET_SCHEDULER_add_now (&try_connect, NULL);
 397   }
 398 }
 399
 400
 401 static void
 402 process_hello (void *cls, const struct GNUNET_MessageHeader *message)
 403 {
 404   struct PeerContext *p = cls;
 405
 406   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 407               "Received (my) `%s' from transport service\n", "HELLO");
 408   GNUNET_assert (message != NULL);
 409   p->hello = GNUNET_copy_message (message);
 410   if ((p == &p1) && (p2.th != NULL))
 411     GNUNET_TRANSPORT_offer_hello (p2.th, message, NULL, NULL);
 412   if ((p == &p2) && (p1.th != NULL))
 413     GNUNET_TRANSPORT_offer_hello (p1.th, message, NULL, NULL);
 414
 415   if ((p == &p1) && (p2.hello != NULL))
 416     GNUNET_TRANSPORT_offer_hello (p1.th, p2.hello, NULL, NULL);
 417   if ((p == &p2) && (p1.hello != NULL))
 418     GNUNET_TRANSPORT_offer_hello (p2.th, p1.hello, NULL, NULL);
 419 }
 420
 421
 422 static void
 423 setup_peer (struct PeerContext *p, const char *cfgname)
 424 {
 425   char *binary;
 426
 427   binary = GNUNET_OS_get_libexec_binary_path ("gnunet-service-arm");
 428   p->cfg = GNUNET_CONFIGURATION_create ();
 429   p->arm_proc =
 430     GNUNET_OS_start_process (GNUNET_YES, GNUNET_OS_INHERIT_STD_OUT_AND_ERR,
 431                              NULL, NULL, NULL,
 432                              binary,
 433                              "gnunet-service-arm",
 434                              "-c", cfgname, NULL);
 435   GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_load (p->cfg, cfgname));
 436   p->th = GNUNET_TRANSPORT_connect (p->cfg, NULL, p, NULL, NULL, NULL);
 437   GNUNET_assert (p->th != NULL);
 438   p->ghh = GNUNET_TRANSPORT_get_hello (p->th, &process_hello, p);
 439   GNUNET_free (binary);
 440 }
 441
 442
 443 static void
 444 run (void *cls, char *const *args, const char *cfgfile,
 445      const struct GNUNET_CONFIGURATION_Handle *cfg)
 446 {
 447   GNUNET_assert (ok == 1);
 448   OKPP;
 449   setup_peer (&p1, "test_core_api_peer1.conf");
 450   setup_peer (&p2, "test_core_api_peer2.conf");
 451   err_task =
 452       GNUNET_SCHEDULER_add_delayed (TIMEOUT, &terminate_task_error, NULL);
 453
 454   GNUNET_assert (NULL != (p1.ch = GNUNET_CORE_connect (p1.cfg, &p1,
 455                                                        &init_notify,
 456                                                        &connect_notify,
 457                                                        &disconnect_notify,
 458                                                        &inbound_notify, GNUNET_YES,
 459                                                        &outbound_notify, GNUNET_YES,
 460                                                        handlers)));
 461 }
 462
 463
 464 static void
 465 stop_arm (struct PeerContext *p)
 466 {
 467   if (0 != GNUNET_OS_process_kill (p->arm_proc, GNUNET_TERM_SIG))
 468     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
 469   if (GNUNET_OS_process_wait (p->arm_proc) != GNUNET_OK)
 470     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "waitpid");
 471   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ARM process %u stopped\n",
 472               GNUNET_OS_process_get_pid (p->arm_proc));
 473   GNUNET_OS_process_destroy (p->arm_proc);
 474   p->arm_proc = NULL;
 475   GNUNET_CONFIGURATION_destroy (p->cfg);
 476 }
 477
 478
 479 int
 480 main (int argc, char *argv1[])
 481 {
 482   char *const argv[] = { "test-core-api-reliability",
 483     "-c",
 484     "test_core_api_data.conf",
 485     NULL
 486   };
 487   struct GNUNET_GETOPT_CommandLineOption options[] = {
 488     GNUNET_GETOPT_OPTION_END
 489   };
 490   ok = 1;
 491   GNUNET_log_setup ("test-core-api-reliability",
 492                     "WARNING",
 493                     NULL);
 494   GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1, argv,
 495                       "test-core-api-reliability", "nohelp", options, &run,
 496                       &ok);
 497   stop_arm (&p1);
 498   stop_arm (&p2);
 499   GNUNET_DISK_directory_remove ("/tmp/test-gnunet-core-peer-1");
 500   GNUNET_DISK_directory_remove ("/tmp/test-gnunet-core-peer-2");
 501
 502   return ok;
 503 }
 504
 505 /* end of test_core_api_reliability.c */