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