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 VERBOSE GNUNET_EXTRA_LOGGING
  37
  38 #define START_ARM GNUNET_YES
  39
  40 /**
  41  * Note that this value must not significantly exceed
  42  * 'MAX_PENDING' in 'gnunet-service-transport.c', otherwise
  43  * messages may be dropped even for a reliable transport.
  44  */
  45 #define TOTAL_MSGS (600 * 10)
  46
  47 /**
  48  * How long until we give up on transmitting the message?
  49  */
  50 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 6000)
  51
  52 /**
  53  * What delay do we request from the core service for transmission?
  54  */
  55 #define FAST_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
  56
  57 #define MTYPE 12345
  58
  59
  60 static unsigned long long total_bytes;
  61
  62 static struct GNUNET_TIME_Absolute start_time;
  63
  64 static GNUNET_SCHEDULER_TaskIdentifier err_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 #if VERBOSE
  91 #define OKPP do { ok++; fprintf (stderr, "Now at stage %u at %s:%u\n", ok, __FILE__, __LINE__); } while (0)
  92 #else
  93 #define OKPP do { ok++; } while (0)
  94 #endif
  95
  96 struct TestMessage
  97 {
  98   struct GNUNET_MessageHeader header;
  99   uint32_t num;
 100 };
 101
 102
 103 static unsigned int
 104 get_size (unsigned int iter)
 105 {
 106   unsigned int ret;
 107
 108   if (iter < 60000)
 109     return iter + sizeof (struct TestMessage);
 110   ret = (iter * iter * iter);
 111   return sizeof (struct TestMessage) + (ret % 60000);
 112 }
 113
 114 static void
 115 process_hello (void *cls, const struct GNUNET_MessageHeader *message);
 116
 117 static void
 118 terminate_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 119 {
 120   unsigned long long delta;
 121
 122   GNUNET_TRANSPORT_get_hello_cancel (p1.ghh);
 123   GNUNET_TRANSPORT_get_hello_cancel (p2.ghh);
 124   GNUNET_CORE_disconnect (p1.ch);
 125   p1.ch = NULL;
 126   GNUNET_CORE_disconnect (p2.ch);
 127   p2.ch = NULL;
 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 (p1.th != NULL)
 156   {
 157     GNUNET_TRANSPORT_get_hello_cancel (p1.ghh);
 158     GNUNET_TRANSPORT_disconnect (p1.th);
 159     p1.th = NULL;
 160   }
 161   if (p2.th != NULL)
 162   {
 163     GNUNET_TRANSPORT_get_hello_cancel (p2.ghh);
 164     GNUNET_TRANSPORT_disconnect (p2.th);
 165     p2.th = NULL;
 166   }
 167   ok = 42;
 168 }
 169
 170
 171 static size_t
 172 transmit_ready (void *cls, size_t size, void *buf)
 173 {
 174   char *cbuf = buf;
 175   struct TestMessage hdr;
 176   unsigned int s;
 177   unsigned int ret;
 178
 179   GNUNET_assert (size <= GNUNET_CONSTANTS_MAX_ENCRYPTED_MESSAGE_SIZE);
 180   if (buf == NULL)
 181   {
 182     if (p1.ch != NULL)
 183       GNUNET_break (NULL !=
 184                     GNUNET_CORE_notify_transmit_ready (p1.ch, GNUNET_NO, 0,
 185                                                        FAST_TIMEOUT, &p2.id,
 186                                                        get_size (tr_n),
 187                                                        &transmit_ready, &p1));
 188     return 0;
 189   }
 190   GNUNET_assert (tr_n < TOTAL_MSGS);
 191   ret = 0;
 192   s = get_size (tr_n);
 193   GNUNET_assert (size >= s);
 194   GNUNET_assert (buf != NULL);
 195   cbuf = buf;
 196   do
 197   {
 198 #if VERBOSE
 199     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 200                 "Sending message %u of size %u at offset %u\n", tr_n, s, ret);
 201 #endif
 202     hdr.header.size = htons (s);
 203     hdr.header.type = htons (MTYPE);
 204     hdr.num = htonl (tr_n);
 205     memcpy (&cbuf[ret], &hdr, sizeof (struct TestMessage));
 206     ret += sizeof (struct TestMessage);
 207     memset (&cbuf[ret], tr_n, s - sizeof (struct TestMessage));
 208     ret += s - sizeof (struct TestMessage);
 209     tr_n++;
 210     s = get_size (tr_n);
 211     if (0 == GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 16))
 212       break;                    /* sometimes pack buffer full, sometimes not */
 213   }
 214   while (size - ret >= s);
 215   GNUNET_SCHEDULER_cancel (err_task);
 216   err_task =
 217       GNUNET_SCHEDULER_add_delayed (TIMEOUT, &terminate_task_error, NULL);
 218   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 219               "Returning total message block of size %u\n", ret);
 220   total_bytes += ret;
 221   return ret;
 222 }
 223
 224
 225
 226 static void
 227 connect_notify (void *cls, const struct GNUNET_PeerIdentity *peer,
 228                 const struct GNUNET_TRANSPORT_ATS_Information *atsi)
 229 {
 230   struct PeerContext *pc = cls;
 231
 232   if (0 == memcmp (&pc->id, peer, sizeof (struct GNUNET_PeerIdentity)))
 233     return;
 234   GNUNET_assert (pc->connect_status == 0);
 235   pc->connect_status = 1;
 236   if (pc == &p1)
 237   {
 238     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 239                 "Encrypted connection established to peer `%4s'\n",
 240                 GNUNET_i2s (peer));
 241     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 242                 "Asking core (1) for transmission to peer `%4s'\n",
 243                 GNUNET_i2s (&p2.id));
 244     GNUNET_SCHEDULER_cancel (err_task);
 245     err_task =
 246         GNUNET_SCHEDULER_add_delayed (TIMEOUT, &terminate_task_error, NULL);
 247     start_time = GNUNET_TIME_absolute_get ();
 248     GNUNET_break (NULL !=
 249                   GNUNET_CORE_notify_transmit_ready (p1.ch, GNUNET_NO, 0,
 250                                                      TIMEOUT, &p2.id,
 251                                                      get_size (0),
 252                                                      &transmit_ready, &p1));
 253   }
 254 }
 255
 256
 257 static void
 258 disconnect_notify (void *cls, const struct GNUNET_PeerIdentity *peer)
 259 {
 260   struct PeerContext *pc = cls;
 261
 262   if (0 == memcmp (&pc->id, peer, sizeof (struct GNUNET_PeerIdentity)))
 263     return;
 264   pc->connect_status = 0;
 265   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Encrypted connection to `%4s' cut\n",
 266               GNUNET_i2s (peer));
 267 }
 268
 269
 270 static int
 271 inbound_notify (void *cls, const struct GNUNET_PeerIdentity *other,
 272                 const struct GNUNET_MessageHeader *message,
 273                 const struct GNUNET_TRANSPORT_ATS_Information *atsi)
 274 {
 275 #if VERBOSE
 276   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 277               "Core provides inbound data from `%4s'.\n", GNUNET_i2s (other));
 278 #endif
 279   return GNUNET_OK;
 280 }
 281
 282
 283 static int
 284 outbound_notify (void *cls, const struct GNUNET_PeerIdentity *other,
 285                  const struct GNUNET_MessageHeader *message,
 286                  const struct GNUNET_TRANSPORT_ATS_Information *atsi)
 287 {
 288 #if VERBOSE
 289   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 290               "Core notifies about outbound data for `%4s'.\n",
 291               GNUNET_i2s (other));
 292 #endif
 293   return GNUNET_OK;
 294 }
 295
 296
 297 static size_t
 298 transmit_ready (void *cls, size_t size, void *buf);
 299
 300 static int
 301 process_mtype (void *cls, const struct GNUNET_PeerIdentity *peer,
 302                const struct GNUNET_MessageHeader *message,
 303                const struct GNUNET_TRANSPORT_ATS_Information *atsi)
 304 {
 305   static int n;
 306   unsigned int s;
 307   const struct TestMessage *hdr;
 308
 309   hdr = (const struct TestMessage *) message;
 310   s = get_size (n);
 311   if (MTYPE != ntohs (message->type))
 312     return GNUNET_SYSERR;
 313   if (ntohs (message->size) != s)
 314   {
 315     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 316                 "Expected message %u of size %u, got %u bytes of message %u\n",
 317                 n, s, ntohs (message->size), ntohl (hdr->num));
 318     GNUNET_SCHEDULER_cancel (err_task);
 319     err_task = GNUNET_SCHEDULER_add_now (&terminate_task_error, NULL);
 320     return GNUNET_SYSERR;
 321   }
 322   if (ntohl (hdr->num) != n)
 323   {
 324     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 325                 "Expected message %u of size %u, got %u bytes of message %u\n",
 326                 n, s, ntohs (message->size), ntohl (hdr->num));
 327     GNUNET_SCHEDULER_cancel (err_task);
 328     err_task = GNUNET_SCHEDULER_add_now (&terminate_task_error, NULL);
 329     return GNUNET_SYSERR;
 330   }
 331 #if VERBOSE
 332   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got message %u of size %u\n",
 333               ntohl (hdr->num), 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, GNUNET_NO, 0,
 348                                                        FAST_TIMEOUT, &p2.id,
 349                                                        get_size (tr_n),
 350                                                        &transmit_ready, &p1));
 351   }
 352   return GNUNET_OK;
 353 }
 354
 355
 356 static struct GNUNET_CORE_MessageHandler handlers[] = {
 357   {&process_mtype, MTYPE, 0},
 358   {NULL, 0, 0}
 359 };
 360
 361
 362
 363 static void
 364 init_notify (void *cls, struct GNUNET_CORE_Handle *server,
 365              const struct GNUNET_PeerIdentity *my_identity)
 366 {
 367   struct PeerContext *p = cls;
 368
 369   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 370               "Connection to CORE service of `%4s' established\n",
 371               GNUNET_i2s (my_identity));
 372   GNUNET_assert (server != NULL);
 373   p->id = *my_identity;
 374   p->ch = server;
 375   if (cls == &p1)
 376   {
 377     GNUNET_assert (ok == 2);
 378     OKPP;
 379     /* connect p2 */
 380     GNUNET_CORE_connect (p2.cfg, 1, &p2, &init_notify, &connect_notify,
 381                          &disconnect_notify, &inbound_notify, GNUNET_YES,
 382                          &outbound_notify, GNUNET_YES, handlers);
 383   }
 384   else
 385   {
 386     GNUNET_assert (ok == 3);
 387     OKPP;
 388     GNUNET_assert (cls == &p2);
 389     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 390                 "Asking transport (1) to connect to peer `%4s'\n",
 391                 GNUNET_i2s (&p2.id));
 392     GNUNET_TRANSPORT_try_connect (p1.th, &p2.id);
 393   }
 394 }
 395
 396
 397 static void
 398 process_hello (void *cls, const struct GNUNET_MessageHeader *message)
 399 {
 400   struct PeerContext *p = cls;
 401
 402   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 403               "Received (my) `%s' from transport service\n", "HELLO");
 404   GNUNET_assert (message != NULL);
 405   p->hello = GNUNET_malloc (ntohs (message->size));
 406   memcpy (p->hello, message, ntohs (message->size));
 407   if ((p == &p1) && (p2.th != NULL))
 408     GNUNET_TRANSPORT_offer_hello (p2.th, message, NULL, NULL);
 409   if ((p == &p2) && (p1.th != NULL))
 410     GNUNET_TRANSPORT_offer_hello (p1.th, message, NULL, NULL);
 411
 412   if ((p == &p1) && (p2.hello != NULL))
 413     GNUNET_TRANSPORT_offer_hello (p1.th, p2.hello, NULL, NULL);
 414   if ((p == &p2) && (p1.hello != NULL))
 415     GNUNET_TRANSPORT_offer_hello (p2.th, p1.hello, NULL, NULL);
 416 }
 417
 418
 419
 420 static void
 421 setup_peer (struct PeerContext *p, const char *cfgname)
 422 {
 423   p->cfg = GNUNET_CONFIGURATION_create ();
 424 #if START_ARM
 425   p->arm_proc =
 426       GNUNET_OS_start_process (NULL, NULL, "gnunet-service-arm",
 427                                "gnunet-service-arm",
 428 #if VERBOSE
 429                                "-L", "DEBUG",
 430 #endif
 431                                "-c", cfgname, NULL);
 432 #endif
 433   GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_load (p->cfg, cfgname));
 434   p->th = GNUNET_TRANSPORT_connect (p->cfg, NULL, p, NULL, NULL, NULL);
 435   GNUNET_assert (p->th != NULL);
 436   p->ghh = GNUNET_TRANSPORT_get_hello (p->th, &process_hello, p);
 437 }
 438
 439
 440 static void
 441 run (void *cls, char *const *args, const char *cfgfile,
 442      const struct GNUNET_CONFIGURATION_Handle *cfg)
 443 {
 444   GNUNET_assert (ok == 1);
 445   OKPP;
 446   setup_peer (&p1, "test_core_api_peer1.conf");
 447   setup_peer (&p2, "test_core_api_peer2.conf");
 448   err_task =
 449       GNUNET_SCHEDULER_add_delayed (TIMEOUT, &terminate_task_error, NULL);
 450   GNUNET_CORE_connect (p1.cfg, 1, &p1, &init_notify, &connect_notify,
 451                        &disconnect_notify, &inbound_notify, GNUNET_YES,
 452                        &outbound_notify, GNUNET_YES, handlers);
 453 }
 454
 455
 456 static void
 457 stop_arm (struct PeerContext *p)
 458 {
 459 #if START_ARM
 460   if (0 != GNUNET_OS_process_kill (p->arm_proc, SIGTERM))
 461     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
 462   if (GNUNET_OS_process_wait (p->arm_proc) != GNUNET_OK)
 463     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "waitpid");
 464   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ARM process %u stopped\n",
 465               GNUNET_OS_process_get_pid (p->arm_proc));
 466   GNUNET_OS_process_close (p->arm_proc);
 467   p->arm_proc = NULL;
 468 #endif
 469   GNUNET_CONFIGURATION_destroy (p->cfg);
 470 }
 471
 472 static int
 473 check ()
 474 {
 475   char *const argv[] = { "test-core-api-reliability",
 476     "-c",
 477     "test_core_api_data.conf",
 478 #if VERBOSE
 479     "-L", "DEBUG",
 480 #endif
 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 int
 496 main (int argc, char *argv[])
 497 {
 498   int ret;
 499
 500   GNUNET_log_setup ("test-core-api",
 501 #if VERBOSE
 502                     "DEBUG",
 503 #else
 504                     "WARNING",
 505 #endif
 506                     NULL);
 507   ret = check ();
 508   GNUNET_DISK_directory_remove ("/tmp/test-gnunet-core-peer-1");
 509   GNUNET_DISK_directory_remove ("/tmp/test-gnunet-core-peer-2");
 510
 511   return ret;
 512 }
 513
 514 /* end of test_core_api_reliability.c */