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", "Core throughput/s", total_bytes * 1000 / 1024 / delta, "kb/s");
 136   ok = 0;
 137 }
 138
 139
 140 static void
 141 terminate_task_error (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 142 {
 143   GNUNET_break (0);
 144   GNUNET_CORE_disconnect (p1.ch);
 145   p1.ch = NULL;
 146   GNUNET_CORE_disconnect (p2.ch);
 147   p2.ch = NULL;
 148   GNUNET_TRANSPORT_disconnect (p1.th);
 149   p1.th = NULL;
 150   GNUNET_TRANSPORT_disconnect (p2.th);
 151   p2.th = NULL;
 152   ok = 42;
 153 }
 154
 155
 156 static size_t
 157 transmit_ready (void *cls, size_t size, void *buf)
 158 {
 159   char *cbuf = buf;
 160   struct TestMessage hdr;
 161   unsigned int s;
 162   unsigned int ret;
 163
 164   GNUNET_assert (size <= GNUNET_CONSTANTS_MAX_ENCRYPTED_MESSAGE_SIZE);
 165   if (buf == NULL)
 166     {
 167       if (p1.ch != NULL)
 168         GNUNET_break (NULL !=
 169                       GNUNET_CORE_notify_transmit_ready (p1.ch,
 170                                                          GNUNET_NO,
 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                                                        GNUNET_NO,
 249                                                        0,
 250                                                        TIMEOUT,
 251                                                        &p2.id,
 252                                                        get_size (0),
 253                                                        &transmit_ready, &p1));
 254     }
 255 }
 256
 257
 258 static void
 259 disconnect_notify (void *cls,
 260                    const struct GNUNET_PeerIdentity *peer)
 261 {
 262   struct PeerContext *pc = cls;
 263
 264   if (0 == memcmp (&pc->id,
 265                    peer,
 266                    sizeof (struct GNUNET_PeerIdentity)))
 267     return;
 268   pc->connect_status = 0;
 269   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 270               "Encrypted connection to `%4s' cut\n", GNUNET_i2s (peer));
 271 }
 272
 273
 274 static int
 275 inbound_notify (void *cls,
 276                 const struct GNUNET_PeerIdentity *other,
 277                 const struct GNUNET_MessageHeader *message,
 278                 const struct GNUNET_TRANSPORT_ATS_Information *atsi)
 279 {
 280 #if VERBOSE
 281   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 282               "Core provides inbound data from `%4s'.\n", GNUNET_i2s (other));
 283 #endif
 284   return GNUNET_OK;
 285 }
 286
 287
 288 static int
 289 outbound_notify (void *cls,
 290                  const struct GNUNET_PeerIdentity *other,
 291                  const struct GNUNET_MessageHeader *message,
 292                  const struct GNUNET_TRANSPORT_ATS_Information *atsi)
 293 {
 294 #if VERBOSE
 295   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 296               "Core notifies about outbound data for `%4s'.\n",
 297               GNUNET_i2s (other));
 298 #endif
 299   return GNUNET_OK;
 300 }
 301
 302
 303 static size_t
 304 transmit_ready (void *cls, size_t size, void *buf);
 305
 306 static int
 307 process_mtype (void *cls,
 308                const struct GNUNET_PeerIdentity *peer,
 309                const struct GNUNET_MessageHeader *message,
 310                const struct GNUNET_TRANSPORT_ATS_Information *atsi)
 311 {
 312   static int n;
 313   unsigned int s;
 314   const struct TestMessage *hdr;
 315
 316   hdr = (const struct TestMessage*) message;
 317   s = get_size (n);
 318   if (MTYPE != ntohs (message->type))
 319     return GNUNET_SYSERR;
 320   if (ntohs (message->size) != s)
 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,
 325                   ntohs (message->size),
 326                   ntohl (hdr->num));
 327       GNUNET_SCHEDULER_cancel (err_task);
 328       err_task = GNUNET_SCHEDULER_add_now (&terminate_task_error, NULL);
 329       return GNUNET_SYSERR;
 330     }
 331   if (ntohl (hdr->num) != n)
 332     {
 333       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 334                   "Expected message %u of size %u, got %u bytes of message %u\n",
 335                   n, s,
 336                   ntohs (message->size),
 337                   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),
 346               ntohs (message->size));
 347 #endif
 348   n++;
 349   if (0 == (n % (TOTAL_MSGS/100)))
 350     fprintf (stderr, ".");
 351   if (n == TOTAL_MSGS)
 352     {
 353       GNUNET_SCHEDULER_cancel (err_task);
 354       GNUNET_SCHEDULER_add_now (&terminate_task, NULL);
 355     }
 356   else
 357     {
 358       if (n == tr_n)
 359         GNUNET_break (NULL !=
 360                       GNUNET_CORE_notify_transmit_ready (p1.ch,
 361                                                          GNUNET_NO,
 362                                                          0,
 363                                                          FAST_TIMEOUT,
 364                                                          &p2.id,
 365                                                          get_size(tr_n),
 366                                                          &transmit_ready, &p1));
 367     }
 368   return GNUNET_OK;
 369 }
 370
 371
 372 static struct GNUNET_CORE_MessageHandler handlers[] = {
 373   {&process_mtype, MTYPE, 0},
 374   {NULL, 0, 0}
 375 };
 376
 377
 378
 379 static void
 380 init_notify (void *cls,
 381              struct GNUNET_CORE_Handle *server,
 382              const struct GNUNET_PeerIdentity *my_identity,
 383              const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *publicKey)
 384 {
 385   struct PeerContext *p = cls;
 386
 387   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 388               "Connection to CORE service of `%4s' established\n",
 389               GNUNET_i2s (my_identity));
 390   GNUNET_assert (server != NULL);
 391   p->id = *my_identity;
 392   p->ch = server;
 393   if (cls == &p1)
 394     {
 395       GNUNET_assert (ok == 2);
 396       OKPP;
 397       /* connect p2 */
 398       GNUNET_CORE_connect (p2.cfg, 1,
 399                            &p2,
 400                            &init_notify,
 401                            &connect_notify,
 402                            &disconnect_notify,
 403                            NULL,
 404                            &inbound_notify,
 405                            GNUNET_YES,
 406                            &outbound_notify, GNUNET_YES, handlers);
 407     }
 408   else
 409     {
 410       GNUNET_assert (ok == 3);
 411       OKPP;
 412       GNUNET_assert (cls == &p2);
 413       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 414                   "Asking core (1) to connect to peer `%4s'\n",
 415                   GNUNET_i2s (&p2.id));
 416       GNUNET_CORE_peer_request_connect (p1.ch,
 417                                         GNUNET_TIME_UNIT_SECONDS,
 418                                         &p2.id,
 419                                         NULL, NULL);
 420     }
 421 }
 422
 423
 424 static void
 425 process_hello (void *cls,
 426                const struct GNUNET_MessageHeader *message)
 427 {
 428   struct PeerContext *p = cls;
 429
 430   GNUNET_TRANSPORT_get_hello_cancel (p->th, &process_hello, p);
 431   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 432               "Received (my) `%s' from transport service\n",
 433               "HELLO");
 434   GNUNET_assert (message != NULL);
 435   p->hello = GNUNET_malloc (ntohs (message->size));
 436   memcpy (p->hello, message, ntohs (message->size));
 437   if ((p == &p1) && (p2.th != NULL))
 438     GNUNET_TRANSPORT_offer_hello (p2.th, message, NULL, NULL);
 439   if ((p == &p2) && (p1.th != NULL))
 440     GNUNET_TRANSPORT_offer_hello (p1.th, message, NULL, NULL);
 441
 442   if ((p == &p1) && (p2.hello != NULL))
 443     GNUNET_TRANSPORT_offer_hello (p1.th, p2.hello, NULL, NULL);
 444   if ((p == &p2) && (p1.hello != NULL))
 445     GNUNET_TRANSPORT_offer_hello (p2.th, p1.hello, NULL, NULL);
 446 }
 447
 448
 449
 450 static void
 451 setup_peer (struct PeerContext *p, const char *cfgname)
 452 {
 453   p->cfg = GNUNET_CONFIGURATION_create ();
 454 #if START_ARM
 455   p->arm_proc = GNUNET_OS_start_process (NULL, NULL, "gnunet-service-arm",
 456                                         "gnunet-service-arm",
 457 #if VERBOSE
 458                                         "-L", "DEBUG",
 459 #endif
 460                                         "-c", cfgname, NULL);
 461 #endif
 462   GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_load (p->cfg, cfgname));
 463   p->th = GNUNET_TRANSPORT_connect (p->cfg, NULL, p, NULL, NULL, NULL);
 464   GNUNET_assert (p->th != NULL);
 465   GNUNET_TRANSPORT_get_hello (p->th, &process_hello, p);
 466 }
 467
 468
 469 static void
 470 run (void *cls,
 471      char *const *args,
 472      const char *cfgfile,
 473      const struct GNUNET_CONFIGURATION_Handle *cfg)
 474 {
 475   GNUNET_assert (ok == 1);
 476   OKPP;
 477   setup_peer (&p1, "test_core_api_peer1.conf");
 478   setup_peer (&p2, "test_core_api_peer2.conf");
 479   GNUNET_CORE_connect (p1.cfg, 1,
 480                        &p1,
 481                        &init_notify,
 482                        &connect_notify,
 483                        &disconnect_notify,
 484                        NULL,
 485                        &inbound_notify,
 486                        GNUNET_YES, &outbound_notify, GNUNET_YES, handlers);
 487 }
 488
 489
 490 static void
 491 stop_arm (struct PeerContext *p)
 492 {
 493 #if START_ARM
 494   if (0 != GNUNET_OS_process_kill (p->arm_proc, SIGTERM))
 495     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
 496   if (GNUNET_OS_process_wait(p->arm_proc) != GNUNET_OK)
 497     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "waitpid");
 498   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 499               "ARM process %u stopped\n", GNUNET_OS_process_get_pid (p->arm_proc));
 500   GNUNET_OS_process_close (p->arm_proc);
 501   p->arm_proc = NULL;
 502 #endif
 503   GNUNET_CONFIGURATION_destroy (p->cfg);
 504 }
 505
 506 static int
 507 check ()
 508 {
 509   char *const argv[] = { "test-core-api-reliability",
 510     "-c",
 511     "test_core_api_data.conf",
 512 #if VERBOSE
 513     "-L", "DEBUG",
 514 #endif
 515     NULL
 516   };
 517   struct GNUNET_GETOPT_CommandLineOption options[] = {
 518     GNUNET_GETOPT_OPTION_END
 519   };
 520   ok = 1;
 521   GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1,
 522                       argv, "test-core-api-reliability", "nohelp", options, &run, &ok);
 523   stop_arm (&p1);
 524   stop_arm (&p2);
 525   return ok;
 526 }
 527
 528 int
 529 main (int argc, char *argv[])
 530 {
 531   int ret;
 532
 533   GNUNET_log_setup ("test-core-api",
 534 #if VERBOSE
 535                     "DEBUG",
 536 #else
 537                     "WARNING",
 538 #endif
 539                     NULL);
 540   ret = check ();
 541   GNUNET_DISK_directory_remove ("/tmp/test-gnunet-core-peer-1");
 542   GNUNET_DISK_directory_remove ("/tmp/test-gnunet-core-peer-2");
 543
 544   return ret;
 545 }
 546
 547 /* end of test_core_api_reliability.c */