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