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