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