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_EXTRA_LOGGING
  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  */
  58 #define FAST_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
  59
  60 #define MTYPE 12345
  61
  62
  63 static unsigned long long total_bytes;
  64
  65 static struct GNUNET_TIME_Absolute start_time;
  66
  67 static GNUNET_SCHEDULER_TaskIdentifier err_task;
  68
  69
  70 struct PeerContext
  71 {
  72   struct GNUNET_CONFIGURATION_Handle *cfg;
  73   struct GNUNET_CORE_Handle *ch;
  74   struct GNUNET_PeerIdentity id;
  75   struct GNUNET_TRANSPORT_Handle *th;
  76   struct GNUNET_MessageHeader *hello;
  77   struct GNUNET_TRANSPORT_GetHelloHandle *ghh;
  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
 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 static void
 118 process_hello (void *cls, const struct GNUNET_MessageHeader *message);
 119
 120 static void
 121 terminate_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 122 {
 123   unsigned long long delta;
 124
 125   GNUNET_TRANSPORT_get_hello_cancel (p1.ghh);
 126   GNUNET_TRANSPORT_get_hello_cancel (p2.ghh);
 127   GNUNET_CORE_disconnect (p1.ch);
 128   p1.ch = NULL;
 129   GNUNET_CORE_disconnect (p2.ch);
 130   p2.ch = NULL;
 131   GNUNET_TRANSPORT_disconnect (p1.th);
 132   p1.th = NULL;
 133   GNUNET_TRANSPORT_disconnect (p2.th);
 134   p2.th = NULL;
 135   delta = GNUNET_TIME_absolute_get_duration (start_time).rel_value;
 136   fprintf (stderr, "\nThroughput was %llu kb/s\n",
 137            total_bytes * 1000 / 1024 / delta);
 138   GAUGER ("CORE", "Core throughput/s", total_bytes * 1000 / 1024 / delta,
 139           "kb/s");
 140   ok = 0;
 141 }
 142
 143
 144 static void
 145 terminate_task_error (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 146 {
 147   GNUNET_break (0);
 148   if (p1.ch != NULL)
 149   {
 150     GNUNET_CORE_disconnect (p1.ch);
 151     p1.ch = NULL;
 152   }
 153   if (p2.ch != NULL)
 154   {
 155     GNUNET_CORE_disconnect (p2.ch);
 156     p2.ch = NULL;
 157   }
 158   if (p1.th != NULL)
 159   {
 160     GNUNET_TRANSPORT_get_hello_cancel (p1.ghh);
 161     GNUNET_TRANSPORT_disconnect (p1.th);
 162     p1.th = NULL;
 163   }
 164   if (p2.th != NULL)
 165   {
 166     GNUNET_TRANSPORT_get_hello_cancel (p2.ghh);
 167     GNUNET_TRANSPORT_disconnect (p2.th);
 168     p2.th = NULL;
 169   }
 170   ok = 42;
 171 }
 172
 173
 174 static size_t
 175 transmit_ready (void *cls, size_t size, void *buf)
 176 {
 177   char *cbuf = buf;
 178   struct TestMessage hdr;
 179   unsigned int s;
 180   unsigned int ret;
 181
 182   GNUNET_assert (size <= GNUNET_CONSTANTS_MAX_ENCRYPTED_MESSAGE_SIZE);
 183   if (buf == NULL)
 184   {
 185     if (p1.ch != NULL)
 186       GNUNET_break (NULL !=
 187                     GNUNET_CORE_notify_transmit_ready (p1.ch, GNUNET_NO, 0,
 188                                                        FAST_TIMEOUT, &p2.id,
 189                                                        get_size (tr_n),
 190                                                        &transmit_ready, &p1));
 191     return 0;
 192   }
 193   GNUNET_assert (tr_n < TOTAL_MSGS);
 194   ret = 0;
 195   s = get_size (tr_n);
 196   GNUNET_assert (size >= s);
 197   GNUNET_assert (buf != NULL);
 198   cbuf = buf;
 199   do
 200   {
 201 #if VERBOSE
 202     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 203                 "Sending message %u of size %u at offset %u\n", tr_n, s, 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, &terminate_task_error, NULL);
 221   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 222               "Returning total message block of size %u\n", ret);
 223   total_bytes += ret;
 224   return ret;
 225 }
 226
 227
 228
 229 static void
 230 connect_notify (void *cls, const struct GNUNET_PeerIdentity *peer,
 231                 const struct GNUNET_TRANSPORT_ATS_Information *atsi)
 232 {
 233   struct PeerContext *pc = cls;
 234
 235   if (0 == memcmp (&pc->id, peer, sizeof (struct GNUNET_PeerIdentity)))
 236     return;
 237   GNUNET_assert (pc->connect_status == 0);
 238   pc->connect_status = 1;
 239   if (pc == &p1)
 240   {
 241     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 242                 "Encrypted connection established to peer `%4s'\n",
 243                 GNUNET_i2s (peer));
 244     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 245                 "Asking core (1) for transmission to peer `%4s'\n",
 246                 GNUNET_i2s (&p2.id));
 247     GNUNET_SCHEDULER_cancel (err_task);
 248     err_task =
 249         GNUNET_SCHEDULER_add_delayed (TIMEOUT, &terminate_task_error, NULL);
 250     start_time = GNUNET_TIME_absolute_get ();
 251     GNUNET_break (NULL !=
 252                   GNUNET_CORE_notify_transmit_ready (p1.ch, GNUNET_NO, 0,
 253                                                      TIMEOUT, &p2.id,
 254                                                      get_size (0),
 255                                                      &transmit_ready, &p1));
 256   }
 257 }
 258
 259
 260 static void
 261 disconnect_notify (void *cls, const struct GNUNET_PeerIdentity *peer)
 262 {
 263   struct PeerContext *pc = cls;
 264
 265   if (0 == memcmp (&pc->id, peer, sizeof (struct GNUNET_PeerIdentity)))
 266     return;
 267   pc->connect_status = 0;
 268   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Encrypted connection to `%4s' cut\n",
 269               GNUNET_i2s (peer));
 270 }
 271
 272
 273 static int
 274 inbound_notify (void *cls, const struct GNUNET_PeerIdentity *other,
 275                 const struct GNUNET_MessageHeader *message,
 276                 const struct GNUNET_TRANSPORT_ATS_Information *atsi)
 277 {
 278 #if VERBOSE
 279   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 280               "Core provides inbound data from `%4s'.\n", GNUNET_i2s (other));
 281 #endif
 282   return GNUNET_OK;
 283 }
 284
 285
 286 static int
 287 outbound_notify (void *cls, const struct GNUNET_PeerIdentity *other,
 288                  const struct GNUNET_MessageHeader *message,
 289                  const struct GNUNET_TRANSPORT_ATS_Information *atsi)
 290 {
 291 #if VERBOSE
 292   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 293               "Core notifies about outbound data for `%4s'.\n",
 294               GNUNET_i2s (other));
 295 #endif
 296   return GNUNET_OK;
 297 }
 298
 299
 300 static size_t
 301 transmit_ready (void *cls, size_t size, void *buf);
 302
 303 static int
 304 process_mtype (void *cls, const struct GNUNET_PeerIdentity *peer,
 305                const struct GNUNET_MessageHeader *message,
 306                const struct GNUNET_TRANSPORT_ATS_Information *atsi)
 307 {
 308   static int n;
 309   unsigned int s;
 310   const struct TestMessage *hdr;
 311
 312   hdr = (const struct TestMessage *) message;
 313   s = get_size (n);
 314   if (MTYPE != ntohs (message->type))
 315     return GNUNET_SYSERR;
 316   if (ntohs (message->size) != s)
 317   {
 318     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 319                 "Expected message %u of size %u, got %u bytes of message %u\n",
 320                 n, s, ntohs (message->size), ntohl (hdr->num));
 321     GNUNET_SCHEDULER_cancel (err_task);
 322     err_task = GNUNET_SCHEDULER_add_now (&terminate_task_error, NULL);
 323     return GNUNET_SYSERR;
 324   }
 325   if (ntohl (hdr->num) != n)
 326   {
 327     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 328                 "Expected message %u of size %u, got %u bytes of message %u\n",
 329                 n, s, ntohs (message->size), ntohl (hdr->num));
 330     GNUNET_SCHEDULER_cancel (err_task);
 331     err_task = GNUNET_SCHEDULER_add_now (&terminate_task_error, NULL);
 332     return GNUNET_SYSERR;
 333   }
 334 #if VERBOSE
 335   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got message %u of size %u\n",
 336               ntohl (hdr->num), ntohs (message->size));
 337 #endif
 338   n++;
 339   if (0 == (n % (TOTAL_MSGS / 100)))
 340     fprintf (stderr, ".");
 341   if (n == TOTAL_MSGS)
 342   {
 343     GNUNET_SCHEDULER_cancel (err_task);
 344     GNUNET_SCHEDULER_add_now (&terminate_task, NULL);
 345   }
 346   else
 347   {
 348     if (n == tr_n)
 349       GNUNET_break (NULL !=
 350                     GNUNET_CORE_notify_transmit_ready (p1.ch, GNUNET_NO, 0,
 351                                                        FAST_TIMEOUT, &p2.id,
 352                                                        get_size (tr_n),
 353                                                        &transmit_ready, &p1));
 354   }
 355   return GNUNET_OK;
 356 }
 357
 358
 359 static struct GNUNET_CORE_MessageHandler handlers[] = {
 360   {&process_mtype, MTYPE, 0},
 361   {NULL, 0, 0}
 362 };
 363
 364
 365
 366 static void
 367 init_notify (void *cls, struct GNUNET_CORE_Handle *server,
 368              const struct GNUNET_PeerIdentity *my_identity)
 369 {
 370   struct PeerContext *p = cls;
 371
 372   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 373               "Connection to CORE service of `%4s' established\n",
 374               GNUNET_i2s (my_identity));
 375   GNUNET_assert (server != NULL);
 376   p->id = *my_identity;
 377   p->ch = server;
 378   if (cls == &p1)
 379   {
 380     GNUNET_assert (ok == 2);
 381     OKPP;
 382     /* connect p2 */
 383     GNUNET_CORE_connect (p2.cfg, 1, &p2, &init_notify, &connect_notify,
 384                          &disconnect_notify, NULL, &inbound_notify, GNUNET_YES,
 385                          &outbound_notify, GNUNET_YES, handlers);
 386   }
 387   else
 388   {
 389     GNUNET_assert (ok == 3);
 390     OKPP;
 391     GNUNET_assert (cls == &p2);
 392     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 393                 "Asking transport (1) to connect to peer `%4s'\n",
 394                 GNUNET_i2s (&p2.id));
 395     GNUNET_TRANSPORT_try_connect (p1.th, &p2.id);
 396   }
 397 }
 398
 399
 400 static void
 401 process_hello (void *cls, const struct GNUNET_MessageHeader *message)
 402 {
 403   struct PeerContext *p = cls;
 404
 405   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 406               "Received (my) `%s' from transport service\n", "HELLO");
 407   GNUNET_assert (message != NULL);
 408   p->hello = GNUNET_malloc (ntohs (message->size));
 409   memcpy (p->hello, message, ntohs (message->size));
 410   if ((p == &p1) && (p2.th != NULL))
 411     GNUNET_TRANSPORT_offer_hello (p2.th, message, NULL, NULL);
 412   if ((p == &p2) && (p1.th != NULL))
 413     GNUNET_TRANSPORT_offer_hello (p1.th, message, NULL, NULL);
 414
 415   if ((p == &p1) && (p2.hello != NULL))
 416     GNUNET_TRANSPORT_offer_hello (p1.th, p2.hello, NULL, NULL);
 417   if ((p == &p2) && (p1.hello != NULL))
 418     GNUNET_TRANSPORT_offer_hello (p2.th, p1.hello, NULL, NULL);
 419 }
 420
 421
 422
 423 static void
 424 setup_peer (struct PeerContext *p, const char *cfgname)
 425 {
 426   p->cfg = GNUNET_CONFIGURATION_create ();
 427 #if START_ARM
 428   p->arm_proc =
 429       GNUNET_OS_start_process (NULL, NULL, "gnunet-service-arm",
 430                                "gnunet-service-arm",
 431 #if VERBOSE
 432                                "-L", "DEBUG",
 433 #endif
 434                                "-c", cfgname, NULL);
 435 #endif
 436   GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_load (p->cfg, cfgname));
 437   p->th = GNUNET_TRANSPORT_connect (p->cfg, NULL, p, NULL, NULL, NULL);
 438   GNUNET_assert (p->th != NULL);
 439   p->ghh = GNUNET_TRANSPORT_get_hello (p->th, &process_hello, p);
 440 }
 441
 442
 443 static void
 444 run (void *cls, char *const *args, const char *cfgfile,
 445      const struct GNUNET_CONFIGURATION_Handle *cfg)
 446 {
 447   GNUNET_assert (ok == 1);
 448   OKPP;
 449   setup_peer (&p1, "test_core_api_peer1.conf");
 450   setup_peer (&p2, "test_core_api_peer2.conf");
 451   err_task =
 452       GNUNET_SCHEDULER_add_delayed (TIMEOUT, &terminate_task_error, NULL);
 453   GNUNET_CORE_connect (p1.cfg, 1, &p1, &init_notify, &connect_notify,
 454                        &disconnect_notify, NULL, &inbound_notify, GNUNET_YES,
 455                        &outbound_notify, GNUNET_YES, handlers);
 456 }
 457
 458
 459 static void
 460 stop_arm (struct PeerContext *p)
 461 {
 462 #if START_ARM
 463   if (0 != GNUNET_OS_process_kill (p->arm_proc, SIGTERM))
 464     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
 465   if (GNUNET_OS_process_wait (p->arm_proc) != GNUNET_OK)
 466     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "waitpid");
 467   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ARM process %u stopped\n",
 468               GNUNET_OS_process_get_pid (p->arm_proc));
 469   GNUNET_OS_process_close (p->arm_proc);
 470   p->arm_proc = NULL;
 471 #endif
 472   GNUNET_CONFIGURATION_destroy (p->cfg);
 473 }
 474
 475 static int
 476 check ()
 477 {
 478   char *const argv[] = { "test-core-api-reliability",
 479     "-c",
 480     "test_core_api_data.conf",
 481 #if VERBOSE
 482     "-L", "DEBUG",
 483 #endif
 484     NULL
 485   };
 486   struct GNUNET_GETOPT_CommandLineOption options[] = {
 487     GNUNET_GETOPT_OPTION_END
 488   };
 489   ok = 1;
 490   GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1, argv,
 491                       "test-core-api-reliability", "nohelp", options, &run,
 492                       &ok);
 493   stop_arm (&p1);
 494   stop_arm (&p2);
 495   return ok;
 496 }
 497
 498 int
 499 main (int argc, char *argv[])
 500 {
 501   int ret;
 502
 503   GNUNET_log_setup ("test-core-api",
 504 #if VERBOSE
 505                     "DEBUG",
 506 #else
 507                     "WARNING",
 508 #endif
 509                     NULL);
 510   ret = check ();
 511   GNUNET_DISK_directory_remove ("/tmp/test-gnunet-core-peer-1");
 512   GNUNET_DISK_directory_remove ("/tmp/test-gnunet-core-peer-2");
 513
 514   return ret;
 515 }
 516
 517 /* end of test_core_api_reliability.c */