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_OfferHelloHandle *oh;
  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 GNUNET_PACKED;
  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->ghh)
 112   {
 113     GNUNET_TRANSPORT_get_hello_cancel (p->ghh);
 114     p->ghh = NULL;
 115   }
 116   if (NULL != p->oh)
 117   {
 118     GNUNET_TRANSPORT_offer_hello_cancel (p->oh);
 119     p->oh = NULL;
 120   }
 121   if (NULL != p->ats_sh)
 122   {
 123     GNUNET_ATS_connectivity_suggest_cancel (p->ats_sh);
 124     p->ats_sh = NULL;
 125   }
 126   if (NULL != p->ats)
 127   {
 128     GNUNET_ATS_connectivity_done (p->ats);
 129     p->ats = NULL;
 130   }
 131 }
 132
 133
 134 static void
 135 terminate_task (void *cls)
 136 {
 137   unsigned long long delta;
 138
 139   delta = GNUNET_TIME_absolute_get_duration (start_time).rel_value_us;
 140   FPRINTF (stderr,
 141            "\nThroughput was %llu kb/s\n",
 142            total_bytes * 1000000LL / 1024 / delta);
 143   GAUGER ("CORE",
 144           "Core throughput/s",
 145           total_bytes * 1000000LL / 1024 / delta,
 146           "kb/s");
 147   GNUNET_SCHEDULER_shutdown ();
 148   ok = 0;
 149 }
 150
 151
 152 static void
 153 terminate_task_error (void *cls)
 154 {
 155   err_task = NULL;
 156   GNUNET_break (0);
 157   GNUNET_SCHEDULER_shutdown ();
 158   ok = 42;
 159 }
 160
 161
 162 static void
 163 do_shutdown (void *cls)
 164 {
 165   if (NULL != err_task)
 166   {
 167     GNUNET_SCHEDULER_cancel (err_task);
 168     err_task = NULL;
 169   }
 170   terminate_peer (&p1);
 171   terminate_peer (&p2);
 172 }
 173
 174
 175 static size_t
 176 transmit_ready (void *cls,
 177                 size_t size,
 178                 void *buf)
 179 {
 180   char *cbuf = buf;
 181   struct TestMessage hdr;
 182   unsigned int s;
 183   unsigned int ret;
 184
 185   GNUNET_assert (size <= GNUNET_CONSTANTS_MAX_ENCRYPTED_MESSAGE_SIZE);
 186   if (NULL == buf)
 187   {
 188     if (NULL != p1.ch)
 189       GNUNET_break (NULL !=
 190                     GNUNET_CORE_notify_transmit_ready (p1.ch, GNUNET_NO,
 191                                                        GNUNET_CORE_PRIO_BEST_EFFORT,
 192                                                        FAST_TIMEOUT, &p2.id,
 193                                                        get_size (tr_n),
 194                                                        &transmit_ready, &p1));
 195     return 0;
 196   }
 197   GNUNET_assert (tr_n < TOTAL_MSGS);
 198   ret = 0;
 199   s = get_size (tr_n);
 200   GNUNET_assert (size >= s);
 201   GNUNET_assert (buf != NULL);
 202   cbuf = buf;
 203   do
 204   {
 205     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 206                 "Sending message %u of size %u at offset %u\n",
 207                 tr_n,
 208                 s,
 209                 ret);
 210     hdr.header.size = htons (s);
 211     hdr.header.type = htons (MTYPE);
 212     hdr.num = htonl (tr_n);
 213     GNUNET_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,
 226                                     &terminate_task_error, NULL);
 227   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 228               "Returning total message block of size %u\n",
 229               ret);
 230   total_bytes += ret;
 231   return ret;
 232 }
 233
 234
 235 static void
 236 connect_notify (void *cls,
 237                 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,
 269                    const struct GNUNET_PeerIdentity *peer)
 270 {
 271   struct PeerContext *pc = cls;
 272
 273   if (0 == memcmp (&pc->id, peer, sizeof (struct GNUNET_PeerIdentity)))
 274     return;
 275   pc->connect_status = 0;
 276   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 277               "Encrypted connection to `%s' cut\n",
 278               GNUNET_i2s (peer));
 279 }
 280
 281
 282 static int
 283 inbound_notify (void *cls,
 284                 const struct GNUNET_PeerIdentity *other,
 285                 const struct GNUNET_MessageHeader *message)
 286 {
 287   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 288               "Core provides inbound data from `%s'.\n",
 289               GNUNET_i2s (other));
 290   return GNUNET_OK;
 291 }
 292
 293
 294 static int
 295 outbound_notify (void *cls,
 296                  const struct GNUNET_PeerIdentity *other,
 297                  const struct GNUNET_MessageHeader *message)
 298 {
 299   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 300               "Core notifies about outbound data for `%s'.\n",
 301               GNUNET_i2s (other));
 302   return GNUNET_OK;
 303 }
 304
 305
 306 static size_t
 307 transmit_ready (void *cls,
 308                 size_t size,
 309                 void *buf);
 310
 311
 312 static int
 313 process_mtype (void *cls,
 314                const struct GNUNET_PeerIdentity *peer,
 315                const struct GNUNET_MessageHeader *message)
 316 {
 317   static int n;
 318   unsigned int s;
 319   const struct TestMessage *hdr;
 320
 321   hdr = (const struct TestMessage *) message;
 322   s = get_size (n);
 323   if (MTYPE != ntohs (message->type))
 324     return GNUNET_SYSERR;
 325   if (ntohs (message->size) != s)
 326   {
 327     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 328                 "Expected message %u of size %u, got %u bytes of message %u\n",
 329                 n, s,
 330                 ntohs (message->size),
 331                 ntohl (hdr->num));
 332     GNUNET_SCHEDULER_cancel (err_task);
 333     err_task = GNUNET_SCHEDULER_add_now (&terminate_task_error,
 334                                          NULL);
 335     return GNUNET_SYSERR;
 336   }
 337   if (ntohl (hdr->num) != n)
 338   {
 339     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 340                 "Expected message %u of size %u, got %u bytes of message %u\n",
 341                 n, s,
 342                 ntohs (message->size),
 343                 ntohl (hdr->num));
 344     GNUNET_SCHEDULER_cancel (err_task);
 345     err_task = GNUNET_SCHEDULER_add_now (&terminate_task_error, NULL);
 346     return GNUNET_SYSERR;
 347   }
 348   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 349               "Got message %u of size %u\n",
 350               ntohl (hdr->num),
 351               ntohs (message->size));
 352   n++;
 353   if (0 == (n % (TOTAL_MSGS / 100)))
 354     FPRINTF (stderr, "%s",  ".");
 355   if (n == TOTAL_MSGS)
 356   {
 357     GNUNET_SCHEDULER_cancel (err_task);
 358     GNUNET_SCHEDULER_add_now (&terminate_task, NULL);
 359   }
 360   else
 361   {
 362     if (n == tr_n)
 363       GNUNET_break (NULL !=
 364                     GNUNET_CORE_notify_transmit_ready (p1.ch,
 365                                                        GNUNET_NO /* no cork */,
 366                                                        GNUNET_CORE_PRIO_BEST_EFFORT,
 367                                                        FAST_TIMEOUT /* ignored! */,
 368                                                        &p2.id,
 369                                                        get_size (tr_n),
 370                                                        &transmit_ready, &p1));
 371   }
 372   return GNUNET_OK;
 373 }
 374
 375
 376 static struct GNUNET_CORE_MessageHandler handlers[] = {
 377   {&process_mtype, MTYPE, 0},
 378   {NULL, 0, 0}
 379 };
 380
 381
 382 static void
 383 init_notify (void *cls,
 384              const struct GNUNET_PeerIdentity *my_identity)
 385 {
 386   struct PeerContext *p = cls;
 387
 388   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 389               "Connection to CORE service of `%s' established\n",
 390               GNUNET_i2s (my_identity));
 391   p->id = *my_identity;
 392   if (cls == &p1)
 393   {
 394     GNUNET_assert (ok == 2);
 395     OKPP;
 396     /* connect p2 */
 397     GNUNET_assert (NULL != (p2.ch = GNUNET_CORE_connect (p2.cfg, &p2,
 398                                                          &init_notify,
 399                                                          &connect_notify,
 400                                                          &disconnect_notify,
 401                                                          &inbound_notify, GNUNET_YES,
 402                                                          &outbound_notify, GNUNET_YES,
 403                                                          handlers)));
 404   }
 405   else
 406   {
 407     GNUNET_assert (ok == 3);
 408     OKPP;
 409     GNUNET_assert (cls == &p2);
 410     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 411                 "Asking transport (1) to connect to peer `%s'\n",
 412                 GNUNET_i2s (&p2.id));
 413     p1.ats_sh = GNUNET_ATS_connectivity_suggest (p1.ats,
 414                                                  &p2.id,
 415                                                  1);
 416   }
 417 }
 418
 419
 420 static void
 421 offer_hello_done (void *cls)
 422 {
 423   struct PeerContext *p = cls;
 424
 425   p->oh = NULL;
 426 }
 427
 428
 429 static void
 430 process_hello (void *cls,
 431                const struct GNUNET_MessageHeader *message)
 432 {
 433   struct PeerContext *p = cls;
 434
 435   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 436               "Received (my) `%s' from transport service\n", "HELLO");
 437   GNUNET_assert (message != NULL);
 438   p->hello = GNUNET_copy_message (message);
 439   if ((p == &p1) && (NULL == p2.oh))
 440     p2.oh = GNUNET_TRANSPORT_offer_hello (p2.cfg,
 441                                           message,
 442                                           &offer_hello_done,
 443                                           &p2);
 444   if ((p == &p2) && (NULL == p1.oh))
 445     p1.oh = GNUNET_TRANSPORT_offer_hello (p1.cfg,
 446                                           message,
 447                                           &offer_hello_done,
 448                                           &p1);
 449
 450   if ((p == &p1) && (p2.hello != NULL) && (NULL == p1.oh) )
 451     p1.oh = GNUNET_TRANSPORT_offer_hello (p1.cfg,
 452                                           p2.hello,
 453                                           &offer_hello_done,
 454                                           &p1);
 455   if ((p == &p2) && (p1.hello != NULL) && (NULL == p2.oh) )
 456     p2.oh = GNUNET_TRANSPORT_offer_hello (p2.cfg,
 457                                           p1.hello,
 458                                           &offer_hello_done,
 459                                           &p2);
 460 }
 461
 462
 463 static void
 464 setup_peer (struct PeerContext *p,
 465             const char *cfgname)
 466 {
 467   char *binary;
 468
 469   binary = GNUNET_OS_get_libexec_binary_path ("gnunet-service-arm");
 470   p->cfg = GNUNET_CONFIGURATION_create ();
 471   p->arm_proc =
 472     GNUNET_OS_start_process (GNUNET_YES, GNUNET_OS_INHERIT_STD_OUT_AND_ERR,
 473                              NULL, NULL, NULL,
 474                              binary,
 475                              "gnunet-service-arm",
 476                              "-c", cfgname, NULL);
 477   GNUNET_assert (GNUNET_OK ==
 478                  GNUNET_CONFIGURATION_load (p->cfg,
 479                                             cfgname));
 480   p->ats = GNUNET_ATS_connectivity_init (p->cfg);
 481   GNUNET_assert (NULL != p->ats);
 482   p->ghh = GNUNET_TRANSPORT_get_hello (p->cfg,
 483                                        &process_hello,
 484                                        p);
 485   GNUNET_free (binary);
 486 }
 487
 488
 489 static void
 490 run (void *cls,
 491      char *const *args,
 492      const char *cfgfile,
 493      const struct GNUNET_CONFIGURATION_Handle *cfg)
 494 {
 495   GNUNET_assert (ok == 1);
 496   OKPP;
 497   setup_peer (&p1, "test_core_api_peer1.conf");
 498   setup_peer (&p2, "test_core_api_peer2.conf");
 499   err_task =
 500       GNUNET_SCHEDULER_add_delayed (TIMEOUT,
 501                                     &terminate_task_error,
 502                                     NULL);
 503   GNUNET_SCHEDULER_add_shutdown (&do_shutdown,
 504                                  NULL);
 505
 506   GNUNET_assert (NULL !=
 507                  (p1.ch = GNUNET_CORE_connect (p1.cfg, &p1,
 508                                                &init_notify,
 509                                                &connect_notify,
 510                                                &disconnect_notify,
 511                                                &inbound_notify,
 512                                                GNUNET_YES,
 513                                                &outbound_notify,
 514                                                GNUNET_YES,
 515                                                handlers)));
 516 }
 517
 518
 519 static void
 520 stop_arm (struct PeerContext *p)
 521 {
 522   if (0 != GNUNET_OS_process_kill (p->arm_proc,
 523                                    GNUNET_TERM_SIG))
 524     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING,
 525                          "kill");
 526   if (GNUNET_OK != GNUNET_OS_process_wait (p->arm_proc))
 527     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING,
 528                          "waitpid");
 529   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 530               "ARM process %u stopped\n",
 531               GNUNET_OS_process_get_pid (p->arm_proc));
 532   GNUNET_OS_process_destroy (p->arm_proc);
 533   p->arm_proc = NULL;
 534   GNUNET_CONFIGURATION_destroy (p->cfg);
 535 }
 536
 537
 538 int
 539 main (int argc, char *argv1[])
 540 {
 541   char *const argv[] = {
 542     "test-core-api-reliability",
 543     "-c",
 544     "test_core_api_data.conf",
 545     NULL
 546   };
 547   struct GNUNET_GETOPT_CommandLineOption options[] = {
 548     GNUNET_GETOPT_OPTION_END
 549   };
 550   ok = 1;
 551   GNUNET_log_setup ("test-core-api-reliability",
 552                     "WARNING",
 553                     NULL);
 554   GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1,
 555                       argv,
 556                       "test-core-api-reliability",
 557                       "nohelp",
 558                       options,
 559                       &run,
 560                       &ok);
 561   stop_arm (&p1);
 562   stop_arm (&p2);
 563   GNUNET_DISK_directory_remove ("/tmp/test-gnunet-core-peer-1");
 564   GNUNET_DISK_directory_remove ("/tmp/test-gnunet-core-peer-2");
 565
 566   return ok;
 567 }
 568
 569 /* end of test_core_api_reliability.c */