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 #include "platform.h"
  25 #include "gnunet_common.h"
  26 #include "gnunet_constants.h"
  27 #include "gnunet_arm_service.h"
  28 #include "gnunet_core_service.h"
  29 #include "gnunet_getopt_lib.h"
  30 #include "gnunet_os_lib.h"
  31 #include "gnunet_program_lib.h"
  32 #include "gnunet_scheduler_lib.h"
  33 #include "gnunet_transport_service.h"
  34 #include <gauger.h>
  35
  36 #define START_ARM GNUNET_YES
  37
  38 /**
  39  * Note that this value must not significantly exceed
  40  * 'MAX_PENDING' in 'gnunet-service-transport.c', otherwise
  41  * messages may be dropped even for a reliable transport.
  42  */
  43 #define TOTAL_MSGS (600 * 10)
  44
  45 /**
  46  * How long until we give up on transmitting the message?
  47  */
  48 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 6000)
  49
  50 /**
  51  * What delay do we request from the core service for transmission?
  52  */
  53 #define FAST_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
  54
  55 #define MTYPE 12345
  56
  57
  58 static unsigned long long total_bytes;
  59
  60 static struct GNUNET_TIME_Absolute start_time;
  61
  62 static GNUNET_SCHEDULER_TaskIdentifier err_task;
  63
  64 static GNUNET_SCHEDULER_TaskIdentifier connect_task;
  65
  66
  67 struct PeerContext
  68 {
  69   struct GNUNET_CONFIGURATION_Handle *cfg;
  70   struct GNUNET_CORE_Handle *ch;
  71   struct GNUNET_PeerIdentity id;
  72   struct GNUNET_TRANSPORT_Handle *th;
  73   struct GNUNET_MessageHeader *hello;
  74   struct GNUNET_TRANSPORT_GetHelloHandle *ghh;
  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 static int32_t tr_n;
  88
  89
  90 #define OKPP do { ok++; GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Now at stage %u at %s:%u\n", ok, __FILE__, __LINE__); } while (0)
  91
  92 struct TestMessage
  93 {
  94   struct GNUNET_MessageHeader header;
  95   uint32_t num;
  96 };
  97
  98
  99 static unsigned int
 100 get_size (unsigned int iter)
 101 {
 102   unsigned int ret;
 103
 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 process_hello (void *cls, const struct GNUNET_MessageHeader *message);
 113
 114
 115 static void
 116 terminate_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 117 {
 118   unsigned long long delta;
 119
 120   GNUNET_TRANSPORT_get_hello_cancel (p1.ghh);
 121   GNUNET_TRANSPORT_get_hello_cancel (p2.ghh);
 122   GNUNET_CORE_disconnect (p1.ch);
 123   p1.ch = NULL;
 124   GNUNET_CORE_disconnect (p2.ch);
 125   p2.ch = NULL;
 126   if (connect_task != GNUNET_SCHEDULER_NO_TASK)
 127     GNUNET_SCHEDULER_cancel (connect_task);
 128   GNUNET_TRANSPORT_disconnect (p1.th);
 129   p1.th = NULL;
 130   GNUNET_TRANSPORT_disconnect (p2.th);
 131   p2.th = NULL;
 132   delta = GNUNET_TIME_absolute_get_duration (start_time).rel_value;
 133   FPRINTF (stderr, "\nThroughput was %llu kb/s\n",
 134            total_bytes * 1000 / 1024 / delta);
 135   GAUGER ("CORE", "Core throughput/s", total_bytes * 1000 / 1024 / delta,
 136           "kb/s");
 137   ok = 0;
 138 }
 139
 140
 141 static void
 142 terminate_task_error (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 143 {
 144   GNUNET_break (0);
 145   if (p1.ch != NULL)
 146   {
 147     GNUNET_CORE_disconnect (p1.ch);
 148     p1.ch = NULL;
 149   }
 150   if (p2.ch != NULL)
 151   {
 152     GNUNET_CORE_disconnect (p2.ch);
 153     p2.ch = NULL;
 154   }
 155   if (connect_task != GNUNET_SCHEDULER_NO_TASK)
 156     GNUNET_SCHEDULER_cancel (connect_task);
 157   if (p1.th != NULL)
 158   {
 159     GNUNET_TRANSPORT_get_hello_cancel (p1.ghh);
 160     GNUNET_TRANSPORT_disconnect (p1.th);
 161     p1.th = NULL;
 162   }
 163   if (p2.th != NULL)
 164   {
 165     GNUNET_TRANSPORT_get_hello_cancel (p2.ghh);
 166     GNUNET_TRANSPORT_disconnect (p2.th);
 167     p2.th = NULL;
 168   }
 169   ok = 42;
 170 }
 171
 172
 173 static void
 174 try_connect (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 175 {
 176   connect_task =
 177       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS, &try_connect,
 178                                     NULL);
 179   GNUNET_TRANSPORT_try_connect (p1.th, &p2.id);
 180 }
 181
 182
 183 static size_t
 184 transmit_ready (void *cls, size_t size, void *buf)
 185 {
 186   char *cbuf = buf;
 187   struct TestMessage hdr;
 188   unsigned int s;
 189   unsigned int ret;
 190
 191   GNUNET_assert (size <= GNUNET_CONSTANTS_MAX_ENCRYPTED_MESSAGE_SIZE);
 192   if (buf == NULL)
 193   {
 194     if (p1.ch != NULL)
 195       GNUNET_break (NULL !=
 196                     GNUNET_CORE_notify_transmit_ready (p1.ch, GNUNET_NO, 0,
 197                                                        FAST_TIMEOUT, &p2.id,
 198                                                        get_size (tr_n),
 199                                                        &transmit_ready, &p1));
 200     return 0;
 201   }
 202   GNUNET_assert (tr_n < TOTAL_MSGS);
 203   ret = 0;
 204   s = get_size (tr_n);
 205   GNUNET_assert (size >= s);
 206   GNUNET_assert (buf != NULL);
 207   cbuf = buf;
 208   do
 209   {
 210     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 211                 "Sending message %u of size %u at offset %u\n", tr_n, s, ret);
 212     hdr.header.size = htons (s);
 213     hdr.header.type = htons (MTYPE);
 214     hdr.num = htonl (tr_n);
 215     memcpy (&cbuf[ret], &hdr, sizeof (struct TestMessage));
 216     ret += sizeof (struct TestMessage);
 217     memset (&cbuf[ret], tr_n, s - sizeof (struct TestMessage));
 218     ret += s - sizeof (struct TestMessage);
 219     tr_n++;
 220     s = get_size (tr_n);
 221     if (0 == GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 16))
 222       break;                    /* sometimes pack buffer full, sometimes not */
 223   }
 224   while (size - ret >= s);
 225   GNUNET_SCHEDULER_cancel (err_task);
 226   err_task =
 227       GNUNET_SCHEDULER_add_delayed (TIMEOUT, &terminate_task_error, NULL);
 228   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 229               "Returning total message block of size %u\n", ret);
 230   total_bytes += ret;
 231   return ret;
 232 }
 233
 234
 235 static void
 236 connect_notify (void *cls, const struct GNUNET_PeerIdentity *peer,
 237                 const struct GNUNET_ATS_Information *atsi,
 238                 unsigned int atsi_count)
 239 {
 240   struct PeerContext *pc = cls;
 241
 242   if (0 == memcmp (&pc->id, peer, sizeof (struct GNUNET_PeerIdentity)))
 243     return;
 244   GNUNET_assert (pc->connect_status == 0);
 245   pc->connect_status = 1;
 246   if (pc == &p1)
 247   {
 248     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 249                 "Encrypted connection established to peer `%4s'\n",
 250                 GNUNET_i2s (peer));
 251     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 252                 "Asking core (1) for transmission to peer `%4s'\n",
 253                 GNUNET_i2s (&p2.id));
 254     GNUNET_SCHEDULER_cancel (err_task);
 255     err_task =
 256         GNUNET_SCHEDULER_add_delayed (TIMEOUT, &terminate_task_error, NULL);
 257     start_time = GNUNET_TIME_absolute_get ();
 258     GNUNET_break (NULL !=
 259                   GNUNET_CORE_notify_transmit_ready (p1.ch, GNUNET_NO, 0,
 260                                                      TIMEOUT, &p2.id,
 261                                                      get_size (0),
 262                                                      &transmit_ready, &p1));
 263   }
 264 }
 265
 266
 267 static void
 268 disconnect_notify (void *cls, const struct GNUNET_PeerIdentity *peer)
 269 {
 270   struct PeerContext *pc = cls;
 271
 272   if (0 == memcmp (&pc->id, peer, sizeof (struct GNUNET_PeerIdentity)))
 273     return;
 274   pc->connect_status = 0;
 275   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Encrypted connection to `%4s' cut\n",
 276               GNUNET_i2s (peer));
 277 }
 278
 279
 280 static int
 281 inbound_notify (void *cls, const struct GNUNET_PeerIdentity *other,
 282                 const struct GNUNET_MessageHeader *message,
 283                 const struct GNUNET_ATS_Information *atsi,
 284                 unsigned int atsi_count)
 285 {
 286   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 287               "Core provides inbound data from `%4s'.\n", GNUNET_i2s (other));
 288   return GNUNET_OK;
 289 }
 290
 291
 292 static int
 293 outbound_notify (void *cls, const struct GNUNET_PeerIdentity *other,
 294                  const struct GNUNET_MessageHeader *message,
 295                  const struct GNUNET_ATS_Information *atsi,
 296                  unsigned int atsi_count)
 297 {
 298   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 299               "Core notifies about outbound data for `%4s'.\n",
 300               GNUNET_i2s (other));
 301   return GNUNET_OK;
 302 }
 303
 304
 305 static size_t
 306 transmit_ready (void *cls, size_t size, void *buf);
 307
 308
 309 static int
 310 process_mtype (void *cls, const struct GNUNET_PeerIdentity *peer,
 311                const struct GNUNET_MessageHeader *message,
 312                const struct GNUNET_ATS_Information *atsi,
 313                unsigned int atsi_count)
 314 {
 315   static int n;
 316   unsigned int s;
 317   const struct TestMessage *hdr;
 318
 319   hdr = (const struct TestMessage *) message;
 320   s = get_size (n);
 321   if (MTYPE != ntohs (message->type))
 322     return GNUNET_SYSERR;
 323   if (ntohs (message->size) != s)
 324   {
 325     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 326                 "Expected message %u of size %u, got %u bytes of message %u\n",
 327                 n, s, ntohs (message->size), ntohl (hdr->num));
 328     GNUNET_SCHEDULER_cancel (err_task);
 329     err_task = GNUNET_SCHEDULER_add_now (&terminate_task_error, NULL);
 330     return GNUNET_SYSERR;
 331   }
 332   if (ntohl (hdr->num) != n)
 333   {
 334     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 335                 "Expected message %u of size %u, got %u bytes of message %u\n",
 336                 n, s, ntohs (message->size), ntohl (hdr->num));
 337     GNUNET_SCHEDULER_cancel (err_task);
 338     err_task = GNUNET_SCHEDULER_add_now (&terminate_task_error, NULL);
 339     return GNUNET_SYSERR;
 340   }
 341   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got message %u of size %u\n",
 342               ntohl (hdr->num), ntohs (message->size));
 343   n++;
 344   if (0 == (n % (TOTAL_MSGS / 100)))
 345     FPRINTF (stderr, "%s",  ".");
 346   if (n == TOTAL_MSGS)
 347   {
 348     GNUNET_SCHEDULER_cancel (err_task);
 349     GNUNET_SCHEDULER_add_now (&terminate_task, NULL);
 350   }
 351   else
 352   {
 353     if (n == tr_n)
 354       GNUNET_break (NULL !=
 355                     GNUNET_CORE_notify_transmit_ready (p1.ch, GNUNET_NO, 0,
 356                                                        FAST_TIMEOUT, &p2.id,
 357                                                        get_size (tr_n),
 358                                                        &transmit_ready, &p1));
 359   }
 360   return GNUNET_OK;
 361 }
 362
 363
 364 static struct GNUNET_CORE_MessageHandler handlers[] = {
 365   {&process_mtype, MTYPE, 0},
 366   {NULL, 0, 0}
 367 };
 368
 369
 370 static void
 371 init_notify (void *cls, struct GNUNET_CORE_Handle *server,
 372              const struct GNUNET_PeerIdentity *my_identity)
 373 {
 374   struct PeerContext *p = cls;
 375
 376   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 377               "Connection to CORE service of `%4s' established\n",
 378               GNUNET_i2s (my_identity));
 379   GNUNET_assert (server != NULL);
 380   p->id = *my_identity;
 381   p->ch = server;
 382   if (cls == &p1)
 383   {
 384     GNUNET_assert (ok == 2);
 385     OKPP;
 386     /* connect p2 */
 387     GNUNET_CORE_connect (p2.cfg, &p2, &init_notify, &connect_notify,
 388                          &disconnect_notify, &inbound_notify, GNUNET_YES,
 389                          &outbound_notify, GNUNET_YES, handlers);
 390   }
 391   else
 392   {
 393     GNUNET_assert (ok == 3);
 394     OKPP;
 395     GNUNET_assert (cls == &p2);
 396     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 397                 "Asking transport (1) to connect to peer `%4s'\n",
 398                 GNUNET_i2s (&p2.id));
 399     connect_task = GNUNET_SCHEDULER_add_now (&try_connect, NULL);
 400   }
 401 }
 402
 403
 404 static void
 405 process_hello (void *cls, const struct GNUNET_MessageHeader *message)
 406 {
 407   struct PeerContext *p = cls;
 408
 409   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 410               "Received (my) `%s' from transport service\n", "HELLO");
 411   GNUNET_assert (message != NULL);
 412   p->hello = GNUNET_malloc (ntohs (message->size));
 413   memcpy (p->hello, message, ntohs (message->size));
 414   if ((p == &p1) && (p2.th != NULL))
 415     GNUNET_TRANSPORT_offer_hello (p2.th, message, NULL, NULL);
 416   if ((p == &p2) && (p1.th != NULL))
 417     GNUNET_TRANSPORT_offer_hello (p1.th, message, NULL, NULL);
 418
 419   if ((p == &p1) && (p2.hello != NULL))
 420     GNUNET_TRANSPORT_offer_hello (p1.th, p2.hello, NULL, NULL);
 421   if ((p == &p2) && (p1.hello != NULL))
 422     GNUNET_TRANSPORT_offer_hello (p2.th, p1.hello, NULL, NULL);
 423 }
 424
 425
 426 static void
 427 setup_peer (struct PeerContext *p, const char *cfgname)
 428 {
 429   p->cfg = GNUNET_CONFIGURATION_create ();
 430 #if START_ARM
 431   p->arm_proc =
 432     GNUNET_OS_start_process (GNUNET_YES, NULL, NULL, "gnunet-service-arm",
 433                                "gnunet-service-arm",
 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, &p1, &init_notify, &connect_notify,
 454                        &disconnect_notify, &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_destroy (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     NULL
 482   };
 483   struct GNUNET_GETOPT_CommandLineOption options[] = {
 484     GNUNET_GETOPT_OPTION_END
 485   };
 486   ok = 1;
 487   GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1, argv,
 488                       "test-core-api-reliability", "nohelp", options, &run,
 489                       &ok);
 490   stop_arm (&p1);
 491   stop_arm (&p2);
 492   return ok;
 493 }
 494
 495
 496 int
 497 main (int argc, char *argv[])
 498 {
 499   int ret;
 500
 501   GNUNET_log_setup ("test-core-api",
 502                     "WARNING",
 503                     NULL);
 504   ret = check ();
 505   GNUNET_DISK_directory_remove ("/tmp/test-gnunet-core-peer-1");
 506   GNUNET_DISK_directory_remove ("/tmp/test-gnunet-core-peer-2");
 507
 508   return ret;
 509 }
 510
 511 /* end of test_core_api_reliability.c */