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                 const struct GNUNET_SCHEDULER_TaskContext *tc)
 133 {
 134   unsigned long long delta;
 135
 136   terminate_peer (&p1);
 137   terminate_peer (&p2);
 138   delta = GNUNET_TIME_absolute_get_duration (start_time).rel_value_us;
 139   FPRINTF (stderr,
 140            "\nThroughput was %llu kb/s\n",
 141            total_bytes * 1000000LL / 1024 / delta);
 142   GAUGER ("CORE", "Core throughput/s", total_bytes * 1000000LL / 1024 / delta,
 143           "kb/s");
 144   ok = 0;
 145 }
 146
 147
 148 static void
 149 terminate_task_error (void *cls,
 150                       const struct GNUNET_SCHEDULER_TaskContext *tc)
 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, size_t size, void *buf)
 161 {
 162   char *cbuf = buf;
 163   struct TestMessage hdr;
 164   unsigned int s;
 165   unsigned int ret;
 166
 167   GNUNET_assert (size <= GNUNET_CONSTANTS_MAX_ENCRYPTED_MESSAGE_SIZE);
 168   if (NULL == buf)
 169   {
 170     if (NULL != p1.ch)
 171       GNUNET_break (NULL !=
 172                     GNUNET_CORE_notify_transmit_ready (p1.ch, GNUNET_NO,
 173                                                        GNUNET_CORE_PRIO_BEST_EFFORT,
 174                                                        FAST_TIMEOUT, &p2.id,
 175                                                        get_size (tr_n),
 176                                                        &transmit_ready, &p1));
 177     return 0;
 178   }
 179   GNUNET_assert (tr_n < TOTAL_MSGS);
 180   ret = 0;
 181   s = get_size (tr_n);
 182   GNUNET_assert (size >= s);
 183   GNUNET_assert (buf != NULL);
 184   cbuf = buf;
 185   do
 186   {
 187     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 188                 "Sending message %u of size %u at offset %u\n", tr_n, s, ret);
 189     hdr.header.size = htons (s);
 190     hdr.header.type = htons (MTYPE);
 191     hdr.num = htonl (tr_n);
 192     memcpy (&cbuf[ret], &hdr, sizeof (struct TestMessage));
 193     ret += sizeof (struct TestMessage);
 194     memset (&cbuf[ret], tr_n, s - sizeof (struct TestMessage));
 195     ret += s - sizeof (struct TestMessage);
 196     tr_n++;
 197     s = get_size (tr_n);
 198     if (0 == GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 16))
 199       break;                    /* sometimes pack buffer full, sometimes not */
 200   }
 201   while (size - ret >= s);
 202   GNUNET_SCHEDULER_cancel (err_task);
 203   err_task =
 204       GNUNET_SCHEDULER_add_delayed (TIMEOUT,
 205                                     &terminate_task_error, NULL);
 206   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 207               "Returning total message block of size %u\n", ret);
 208   total_bytes += ret;
 209   return ret;
 210 }
 211
 212
 213 static void
 214 connect_notify (void *cls, const struct GNUNET_PeerIdentity *peer)
 215 {
 216   struct PeerContext *pc = cls;
 217
 218   if (0 == memcmp (&pc->id, peer, sizeof (struct GNUNET_PeerIdentity)))
 219     return;
 220   GNUNET_assert (pc->connect_status == 0);
 221   pc->connect_status = 1;
 222   if (pc == &p1)
 223   {
 224     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 225                 "Encrypted connection established to peer `%s'\n",
 226                 GNUNET_i2s (peer));
 227     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 228                 "Asking core (1) for transmission to peer `%s'\n",
 229                 GNUNET_i2s (&p2.id));
 230     GNUNET_SCHEDULER_cancel (err_task);
 231     err_task =
 232         GNUNET_SCHEDULER_add_delayed (TIMEOUT, &terminate_task_error, NULL);
 233     start_time = GNUNET_TIME_absolute_get ();
 234     GNUNET_break (NULL !=
 235                   GNUNET_CORE_notify_transmit_ready (p1.ch, GNUNET_NO,
 236                                                      GNUNET_CORE_PRIO_BEST_EFFORT,
 237                                                      TIMEOUT, &p2.id,
 238                                                      get_size (0),
 239                                                      &transmit_ready, &p1));
 240   }
 241 }
 242
 243
 244 static void
 245 disconnect_notify (void *cls, const struct GNUNET_PeerIdentity *peer)
 246 {
 247   struct PeerContext *pc = cls;
 248
 249   if (0 == memcmp (&pc->id, peer, sizeof (struct GNUNET_PeerIdentity)))
 250     return;
 251   pc->connect_status = 0;
 252   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Encrypted connection to `%s' cut\n",
 253               GNUNET_i2s (peer));
 254 }
 255
 256
 257 static int
 258 inbound_notify (void *cls, const struct GNUNET_PeerIdentity *other,
 259                 const struct GNUNET_MessageHeader *message)
 260 {
 261   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 262               "Core provides inbound data from `%s'.\n", GNUNET_i2s (other));
 263   return GNUNET_OK;
 264 }
 265
 266
 267 static int
 268 outbound_notify (void *cls, const struct GNUNET_PeerIdentity *other,
 269                  const struct GNUNET_MessageHeader *message)
 270 {
 271   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 272               "Core notifies about outbound data for `%s'.\n",
 273               GNUNET_i2s (other));
 274   return GNUNET_OK;
 275 }
 276
 277
 278 static size_t
 279 transmit_ready (void *cls, size_t size, void *buf);
 280
 281
 282 static int
 283 process_mtype (void *cls,
 284                const struct GNUNET_PeerIdentity *peer,
 285                const struct GNUNET_MessageHeader *message)
 286 {
 287   static int n;
 288   unsigned int s;
 289   const struct TestMessage *hdr;
 290
 291   hdr = (const struct TestMessage *) message;
 292   s = get_size (n);
 293   if (MTYPE != ntohs (message->type))
 294     return GNUNET_SYSERR;
 295   if (ntohs (message->size) != s)
 296   {
 297     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 298                 "Expected message %u of size %u, got %u bytes of message %u\n",
 299                 n, s, ntohs (message->size), ntohl (hdr->num));
 300     GNUNET_SCHEDULER_cancel (err_task);
 301     err_task = GNUNET_SCHEDULER_add_now (&terminate_task_error, NULL);
 302     return GNUNET_SYSERR;
 303   }
 304   if (ntohl (hdr->num) != n)
 305   {
 306     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 307                 "Expected message %u of size %u, got %u bytes of message %u\n",
 308                 n, s, ntohs (message->size), ntohl (hdr->num));
 309     GNUNET_SCHEDULER_cancel (err_task);
 310     err_task = GNUNET_SCHEDULER_add_now (&terminate_task_error, NULL);
 311     return GNUNET_SYSERR;
 312   }
 313   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got message %u of size %u\n",
 314               ntohl (hdr->num), ntohs (message->size));
 315   n++;
 316   if (0 == (n % (TOTAL_MSGS / 100)))
 317     FPRINTF (stderr, "%s",  ".");
 318   if (n == TOTAL_MSGS)
 319   {
 320     GNUNET_SCHEDULER_cancel (err_task);
 321     GNUNET_SCHEDULER_add_now (&terminate_task, NULL);
 322   }
 323   else
 324   {
 325     if (n == tr_n)
 326       GNUNET_break (NULL !=
 327                     GNUNET_CORE_notify_transmit_ready (p1.ch,
 328                                                        GNUNET_NO /* no cork */,
 329                                                        GNUNET_CORE_PRIO_BEST_EFFORT,
 330                                                        FAST_TIMEOUT /* ignored! */,
 331                                                        &p2.id,
 332                                                        get_size (tr_n),
 333                                                        &transmit_ready, &p1));
 334   }
 335   return GNUNET_OK;
 336 }
 337
 338
 339 static struct GNUNET_CORE_MessageHandler handlers[] = {
 340   {&process_mtype, MTYPE, 0},
 341   {NULL, 0, 0}
 342 };
 343
 344
 345 static void
 346 init_notify (void *cls,
 347              const struct GNUNET_PeerIdentity *my_identity)
 348 {
 349   struct PeerContext *p = cls;
 350
 351   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 352               "Connection to CORE service of `%s' established\n",
 353               GNUNET_i2s (my_identity));
 354   p->id = *my_identity;
 355   if (cls == &p1)
 356   {
 357     GNUNET_assert (ok == 2);
 358     OKPP;
 359     /* connect p2 */
 360     GNUNET_assert (NULL != (p2.ch = GNUNET_CORE_connect (p2.cfg, &p2,
 361                                                          &init_notify,
 362                                                          &connect_notify,
 363                                                          &disconnect_notify,
 364                                                          &inbound_notify, GNUNET_YES,
 365                                                          &outbound_notify, GNUNET_YES,
 366                                                          handlers)));
 367   }
 368   else
 369   {
 370     GNUNET_assert (ok == 3);
 371     OKPP;
 372     GNUNET_assert (cls == &p2);
 373     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 374                 "Asking transport (1) to connect to peer `%s'\n",
 375                 GNUNET_i2s (&p2.id));
 376     p1.ats_sh = GNUNET_ATS_connectivity_suggest (p1.ats,
 377                                                  &p2.id,
 378                                                  1);
 379   }
 380 }
 381
 382
 383 static void
 384 process_hello (void *cls, const struct GNUNET_MessageHeader *message)
 385 {
 386   struct PeerContext *p = cls;
 387
 388   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 389               "Received (my) `%s' from transport service\n", "HELLO");
 390   GNUNET_assert (message != NULL);
 391   p->hello = GNUNET_copy_message (message);
 392   if ((p == &p1) && (p2.th != NULL))
 393     GNUNET_TRANSPORT_offer_hello (p2.th, message, NULL, NULL);
 394   if ((p == &p2) && (p1.th != NULL))
 395     GNUNET_TRANSPORT_offer_hello (p1.th, message, NULL, NULL);
 396
 397   if ((p == &p1) && (p2.hello != NULL))
 398     GNUNET_TRANSPORT_offer_hello (p1.th, p2.hello, NULL, NULL);
 399   if ((p == &p2) && (p1.hello != NULL))
 400     GNUNET_TRANSPORT_offer_hello (p2.th, p1.hello, NULL, NULL);
 401 }
 402
 403
 404 static void
 405 setup_peer (struct PeerContext *p, const char *cfgname)
 406 {
 407   char *binary;
 408
 409   binary = GNUNET_OS_get_libexec_binary_path ("gnunet-service-arm");
 410   p->cfg = GNUNET_CONFIGURATION_create ();
 411   p->arm_proc =
 412     GNUNET_OS_start_process (GNUNET_YES, GNUNET_OS_INHERIT_STD_OUT_AND_ERR,
 413                              NULL, NULL, NULL,
 414                              binary,
 415                              "gnunet-service-arm",
 416                              "-c", cfgname, NULL);
 417   GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_load (p->cfg, cfgname));
 418   p->th = GNUNET_TRANSPORT_connect (p->cfg, NULL, p, NULL, NULL, NULL);
 419   GNUNET_assert (p->th != NULL);
 420   p->ats = GNUNET_ATS_connectivity_init (p->cfg);
 421   GNUNET_assert (NULL != p->ats);
 422   p->ghh = GNUNET_TRANSPORT_get_hello (p->th, &process_hello, p);
 423   GNUNET_free (binary);
 424 }
 425
 426
 427 static void
 428 run (void *cls, char *const *args, const char *cfgfile,
 429      const struct GNUNET_CONFIGURATION_Handle *cfg)
 430 {
 431   GNUNET_assert (ok == 1);
 432   OKPP;
 433   setup_peer (&p1, "test_core_api_peer1.conf");
 434   setup_peer (&p2, "test_core_api_peer2.conf");
 435   err_task =
 436       GNUNET_SCHEDULER_add_delayed (TIMEOUT, &terminate_task_error, NULL);
 437
 438   GNUNET_assert (NULL != (p1.ch = GNUNET_CORE_connect (p1.cfg, &p1,
 439                                                        &init_notify,
 440                                                        &connect_notify,
 441                                                        &disconnect_notify,
 442                                                        &inbound_notify, GNUNET_YES,
 443                                                        &outbound_notify, GNUNET_YES,
 444                                                        handlers)));
 445 }
 446
 447
 448 static void
 449 stop_arm (struct PeerContext *p)
 450 {
 451   if (0 != GNUNET_OS_process_kill (p->arm_proc, GNUNET_TERM_SIG))
 452     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
 453   if (GNUNET_OS_process_wait (p->arm_proc) != GNUNET_OK)
 454     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "waitpid");
 455   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ARM process %u stopped\n",
 456               GNUNET_OS_process_get_pid (p->arm_proc));
 457   GNUNET_OS_process_destroy (p->arm_proc);
 458   p->arm_proc = NULL;
 459   GNUNET_CONFIGURATION_destroy (p->cfg);
 460 }
 461
 462
 463 int
 464 main (int argc, char *argv1[])
 465 {
 466   char *const argv[] = { "test-core-api-reliability",
 467     "-c",
 468     "test_core_api_data.conf",
 469     NULL
 470   };
 471   struct GNUNET_GETOPT_CommandLineOption options[] = {
 472     GNUNET_GETOPT_OPTION_END
 473   };
 474   ok = 1;
 475   GNUNET_log_setup ("test-core-api-reliability",
 476                     "WARNING",
 477                     NULL);
 478   GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1, argv,
 479                       "test-core-api-reliability", "nohelp", options, &run,
 480                       &ok);
 481   stop_arm (&p1);
 482   stop_arm (&p2);
 483   GNUNET_DISK_directory_remove ("/tmp/test-gnunet-core-peer-1");
 484   GNUNET_DISK_directory_remove ("/tmp/test-gnunet-core-peer-2");
 485
 486   return ok;
 487 }
 488
 489 /* end of test_core_api_reliability.c */