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