src/core/test_core_api_reliability.c

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