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