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