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