src/core/test_core_api_reliability.c

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