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 2, 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_YES
  39
  40 #define START_ARM GNUNET_YES
  41
  42 /**
  43  * How long until we give up on transmitting the message?
  44  */
  45 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 60)
  46
  47 /**
  48  * What delay do we request from the core service for transmission?
  49  * Any value smaller than the CORK delay will disable CORKing, which
  50  * is what we want here.
  51  */
  52 #define FAST_TIMEOUT GNUNET_TIME_relative_divide (GNUNET_CONSTANTS_MAX_CORK_DELAY, 2)
  53
  54 #define MTYPE 12345
  55
  56
  57 static unsigned long long total_bytes;
  58
  59 static struct GNUNET_TIME_Absolute start_time;
  60
  61 /**
  62  * Note that this value must not significantly exceed
  63  * 'MAX_PENDING' in 'gnunet-service-transport.c', otherwise
  64  * messages may be dropped even for a reliable transport.
  65  */
  66 #define TOTAL_MSGS (60000 * 2)
  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   pid_t arm_pid;
  78 #endif
  79 };
  80
  81 static struct PeerContext p1;
  82
  83 static struct PeerContext p2;
  84
  85 static struct GNUNET_SCHEDULER_Handle *sched;
  86
  87 static int ok;
  88
  89 #if VERBOSE
  90 #define OKPP do { ok++; fprintf (stderr, "Now at stage %u at %s:%u\n", ok, __FILE__, __LINE__); } while (0)
  91 #else
  92 #define OKPP do { ok++; } while (0)
  93 #endif
  94
  95 struct TestMessage
  96 {
  97   struct GNUNET_MessageHeader header;
  98   uint32_t num;
  99 };
 100
 101
 102 static unsigned int
 103 get_size (unsigned int iter)
 104 {
 105   unsigned int ret;
 106   if (iter < 60000)
 107     return iter + sizeof (struct TestMessage);
 108   ret = (iter * iter * iter);
 109   return sizeof (struct TestMessage) + (ret % 60000);
 110 }
 111
 112
 113 static void
 114 terminate_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 115 {
 116   unsigned long long delta;
 117
 118   GNUNET_CORE_disconnect (p1.ch);
 119   p1.ch = NULL;
 120   GNUNET_CORE_disconnect (p2.ch);
 121   p2.ch = NULL;
 122   GNUNET_TRANSPORT_disconnect (p1.th);
 123   p1.th = NULL;
 124   GNUNET_TRANSPORT_disconnect (p2.th);
 125   p2.th = NULL;
 126   delta = GNUNET_TIME_absolute_get_duration (start_time).value;
 127   fprintf (stderr,
 128            "\nThroughput was %llu kb/s\n",
 129            total_bytes * 1000 / 1024 / delta);
 130   ok = 0;
 131 }
 132
 133
 134 static void
 135 terminate_task_error (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 136 {
 137   GNUNET_break (0);
 138   GNUNET_CORE_disconnect (p1.ch);
 139   p1.ch = NULL;
 140   GNUNET_CORE_disconnect (p2.ch);
 141   p2.ch = NULL;
 142   GNUNET_TRANSPORT_disconnect (p1.th);
 143   p1.th = NULL;
 144   GNUNET_TRANSPORT_disconnect (p2.th);
 145   p2.th = NULL;
 146   ok = 42;
 147 }
 148
 149
 150 static void
 151 connect_notify (void *cls,
 152                 const struct GNUNET_PeerIdentity *peer,
 153                 struct GNUNET_TIME_Relative latency,
 154                 uint32_t distance)
 155 {
 156   struct PeerContext *pc = cls;
 157   GNUNET_assert (pc->connect_status == 0);
 158   pc->connect_status = 1;
 159   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 160               "Encrypted connection established to peer `%4s'\n",
 161               GNUNET_i2s (peer));
 162 }
 163
 164
 165 static void
 166 disconnect_notify (void *cls,
 167                    const struct GNUNET_PeerIdentity *peer)
 168 {
 169   struct PeerContext *pc = cls;
 170   pc->connect_status = 0;
 171   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 172               "Encrypted connection to `%4s' cut\n", GNUNET_i2s (peer));
 173 }
 174
 175
 176 static int
 177 inbound_notify (void *cls,
 178                 const struct GNUNET_PeerIdentity *other,
 179                 const struct GNUNET_MessageHeader *message,
 180                 struct GNUNET_TIME_Relative latency,
 181                 uint32_t distance)
 182 {
 183   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 184               "Core provides inbound data from `%4s'.\n", GNUNET_i2s (other));
 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   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 197               "Core notifies about outbound data for `%4s'.\n",
 198               GNUNET_i2s (other));
 199   return GNUNET_OK;
 200 }
 201
 202
 203 static GNUNET_SCHEDULER_TaskIdentifier err_task;
 204
 205
 206 static size_t
 207 transmit_ready (void *cls, size_t size, void *buf);
 208
 209 static int tr_n;
 210
 211
 212 static int
 213 process_mtype (void *cls,
 214                const struct GNUNET_PeerIdentity *peer,
 215                const struct GNUNET_MessageHeader *message,
 216                struct GNUNET_TIME_Relative latency,
 217                uint32_t distance)
 218 {
 219   static int n;
 220   unsigned int s;
 221   const struct TestMessage *hdr;
 222
 223   hdr = (const struct TestMessage*) message;
 224   s = get_size (n);
 225   if (MTYPE != ntohs (message->type))
 226     return GNUNET_SYSERR;
 227   if (ntohs (message->size) != s)
 228     {
 229       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 230                   "Expected message %u of size %u, got %u bytes of message %u\n",
 231                   n, s,
 232                   ntohs (message->size),
 233                   ntohl (hdr->num));
 234       GNUNET_SCHEDULER_cancel (sched, err_task);
 235       err_task = GNUNET_SCHEDULER_add_now (sched, &terminate_task_error, NULL);
 236       return GNUNET_SYSERR;
 237     }
 238   if (ntohl (hdr->num) != n)
 239     {
 240       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 241                   "Expected message %u of size %u, got %u bytes of message %u\n",
 242                   n, s,
 243                   ntohs (message->size),
 244                   ntohl (hdr->num));
 245       GNUNET_SCHEDULER_cancel (sched, err_task);
 246       err_task = GNUNET_SCHEDULER_add_now (sched, &terminate_task_error, NULL);
 247       return GNUNET_SYSERR;
 248     }
 249 #if VERBOSE
 250   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 251               "Got message %u of size %u\n",
 252               ntohl (hdr->num),
 253               ntohs (message->size));
 254 #endif
 255   n++;
 256   if (0 == (n % (TOTAL_MSGS/100)))
 257     fprintf (stderr, ".");
 258   if (n == TOTAL_MSGS)
 259     {
 260       GNUNET_SCHEDULER_cancel (sched, err_task);
 261       GNUNET_SCHEDULER_add_now (sched, &terminate_task, NULL);
 262     }
 263   else
 264     {
 265       if (n == tr_n)
 266         GNUNET_break (NULL !=
 267                       GNUNET_CORE_notify_transmit_ready (p1.ch,
 268                                                          0,
 269                                                          FAST_TIMEOUT,
 270                                                          &p2.id,
 271                                                          sizeof (struct GNUNET_MessageHeader),
 272                                                          &transmit_ready, &p1));
 273     }
 274   return GNUNET_OK;
 275 }
 276
 277
 278 static struct GNUNET_CORE_MessageHandler handlers[] = {
 279   {&process_mtype, MTYPE, 0},
 280   {NULL, 0, 0}
 281 };
 282
 283
 284 static size_t
 285 transmit_ready (void *cls, size_t size, void *buf)
 286 {
 287   char *cbuf = buf;
 288   struct TestMessage hdr;
 289   unsigned int s;
 290   unsigned int ret;
 291
 292   GNUNET_assert (size <= GNUNET_CONSTANTS_MAX_ENCRYPTED_MESSAGE_SIZE);
 293   if (buf == NULL)
 294     {
 295       if (p1.ch != NULL)
 296         GNUNET_break (NULL !=
 297                       GNUNET_CORE_notify_transmit_ready (p1.ch,
 298                                                          0,
 299                                                          FAST_TIMEOUT,
 300                                                          &p2.id,
 301                                                          sizeof (struct GNUNET_MessageHeader),
 302                                                          &transmit_ready, &p1));
 303       return 0;
 304     }
 305   GNUNET_assert (tr_n < TOTAL_MSGS);
 306   ret = 0;
 307   s = get_size (tr_n);
 308   GNUNET_assert (size >= s);
 309   GNUNET_assert (buf != NULL);
 310   cbuf = buf;
 311   do
 312     {
 313 #if VERBOSE
 314       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 315                   "Sending message %u of size %u at offset %u\n",
 316                   tr_n,
 317                   s,
 318                   ret);
 319 #endif
 320       hdr.header.size = htons (s);
 321       hdr.header.type = htons (MTYPE);
 322       hdr.num = htonl (tr_n);
 323       memcpy (&cbuf[ret], &hdr, sizeof (struct TestMessage));
 324       ret += sizeof (struct TestMessage);
 325       memset (&cbuf[ret], tr_n, s - sizeof (struct TestMessage));
 326       ret += s - sizeof (struct TestMessage);
 327       tr_n++;
 328       s = get_size (tr_n);
 329       if (0 == GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 16))
 330         break; /* sometimes pack buffer full, sometimes not */
 331     }
 332   while (size - ret >= s);
 333   GNUNET_SCHEDULER_cancel (sched, err_task);
 334   err_task =
 335     GNUNET_SCHEDULER_add_delayed (sched,
 336                                   TIMEOUT,
 337                                   &terminate_task_error,
 338                                   NULL);
 339   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 340               "Returning total message block of size %u\n",
 341               ret);
 342   total_bytes += ret;
 343   return ret;
 344 }
 345
 346
 347
 348 static void
 349 init_notify (void *cls,
 350              struct GNUNET_CORE_Handle *server,
 351              const struct GNUNET_PeerIdentity *my_identity,
 352              const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *publicKey)
 353 {
 354   struct PeerContext *p = cls;
 355
 356   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 357               "Connection to CORE service of `%4s' established\n",
 358               GNUNET_i2s (my_identity));
 359   GNUNET_assert (server != NULL);
 360   p->id = *my_identity;
 361   p->ch = server;
 362   if (cls == &p1)
 363     {
 364       GNUNET_assert (ok == 2);
 365       OKPP;
 366       /* connect p2 */
 367       GNUNET_CORE_connect (sched,
 368                            p2.cfg,
 369                            TIMEOUT,
 370                            &p2,
 371                            &init_notify,
 372                            &connect_notify,
 373                            &disconnect_notify,
 374                            &inbound_notify,
 375                            GNUNET_YES,
 376                            &outbound_notify, GNUNET_YES, handlers);
 377     }
 378   else
 379     {
 380       GNUNET_assert (ok == 3);
 381       OKPP;
 382       GNUNET_assert (cls == &p2);
 383       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 384                   "Asking core (1) for transmission to peer `%4s'\n",
 385                   GNUNET_i2s (&p2.id));
 386       err_task =
 387         GNUNET_SCHEDULER_add_delayed (sched,
 388                                       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                                                        sizeof (struct GNUNET_MessageHeader),
 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_pid = 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 (sched, p->cfg, 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      struct GNUNET_SCHEDULER_Handle *s,
 451      char *const *args,
 452      const char *cfgfile,
 453      const struct GNUNET_CONFIGURATION_Handle *cfg)
 454 {
 455   GNUNET_assert (ok == 1);
 456   OKPP;
 457   sched = s;
 458   setup_peer (&p1, "test_core_api_peer1.conf");
 459   setup_peer (&p2, "test_core_api_peer2.conf");
 460   GNUNET_CORE_connect (sched,
 461                        p1.cfg,
 462                        TIMEOUT,
 463                        &p1,
 464                        &init_notify,
 465                        &connect_notify,
 466                        &disconnect_notify,
 467                        &inbound_notify,
 468                        GNUNET_YES, &outbound_notify, GNUNET_YES, handlers);
 469 }
 470
 471
 472 static void
 473 stop_arm (struct PeerContext *p)
 474 {
 475 #if START_ARM
 476   if (0 != PLIBC_KILL (p->arm_pid, SIGTERM))
 477     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
 478   if (GNUNET_OS_process_wait(p->arm_pid) != GNUNET_OK)
 479     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "waitpid");
 480   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 481               "ARM process %u stopped\n", p->arm_pid);
 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 */