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