src/cadet/test_cadet.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2011, 2017 GNUnet e.V.
   4
   5      GNUnet is free software: you can redistribute it and/or modify it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your 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      Affero General Public License for more details.
  14
  15      You should have received a copy of the GNU Affero General Public License
  16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18      SPDX-License-Identifier: AGPL3.0-or-later
  19  */
  20 /**
  21  * @file cadet/test_cadet.c
  22  * @author Bart Polot
  23  * @author Christian Grothoff
  24  * @brief Test for the cadet service using mq API.
  25  */
  26 #include <stdio.h>
  27 #include "platform.h"
  28 #include "cadet_test_lib.h"
  29 #include "gnunet_cadet_service.h"
  30 #include "gnunet_statistics_service.h"
  31 #include <gauger.h>
  32
  33
  34 /**
  35  * Ugly workaround to unify data handlers on incoming and outgoing channels.
  36  */
  37 struct CadetTestChannelWrapper
  38 {
  39   /**
  40    * Channel pointer.
  41    */
  42   struct GNUNET_CADET_Channel *ch;
  43 };
  44
  45 /**
  46  * How many messages to send by default.
  47  */
  48 #define TOTAL_PACKETS 500       /* Cannot exceed 64k! */
  49
  50 /**
  51  * How long until we give up on connecting the peers?
  52  */
  53 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 120)
  54
  55 /**
  56  * Time to wait by default  for stuff that should be rather fast.
  57  */
  58 #define SHORT_TIME GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 20)
  59
  60 /**
  61  * How fast do we send messages?
  62  */
  63 #define SEND_INTERVAL GNUNET_TIME_relative_multiply ( \
  64     GNUNET_TIME_UNIT_MILLISECONDS, 10)
  65
  66 /**
  67  * DIFFERENT TESTS TO RUN
  68  */
  69 #define SETUP 0
  70 #define FORWARD 1
  71 #define KEEPALIVE 2
  72 #define SPEED 3
  73 #define SPEED_ACK 4
  74 #define SPEED_REL 8
  75 #define P2P_SIGNAL 10
  76 #define REOPEN 11
  77
  78 /**
  79  * Which test are we running?
  80  */
  81 static int test;
  82
  83 /**
  84  * String with test name
  85  */
  86 static char *test_name;
  87
  88 /**
  89  * Flag to send traffic leaf->root in speed tests to test BCK_ACK logic.
  90  */
  91 static int test_backwards = GNUNET_NO;
  92
  93 /**
  94  * How many packets to send.
  95  */
  96 static unsigned int total_packets;
  97
  98 /**
  99  * Time to wait for fast operations.
 100  */
 101 static struct GNUNET_TIME_Relative short_time;
 102
 103 /**
 104  * How many events have happened
 105  */
 106 static int ok;
 107
 108 /**
 109  * Number of events expected to conclude the test successfully.
 110  */
 111 static int ok_goal;
 112
 113 /**
 114  * Size of each test packet's payload
 115  */
 116 static size_t size_payload = sizeof(uint32_t);
 117
 118 /**
 119  * Operation to get peer ids.
 120  */
 121 static struct GNUNET_TESTBED_Operation *t_op[2];
 122
 123 /**
 124  * Peer ids.
 125  */
 126 static struct GNUNET_PeerIdentity *p_id[2];
 127
 128 /**
 129  * Port ID
 130  */
 131 static struct GNUNET_HashCode port;
 132
 133 /**
 134  * Peer ids counter.
 135  */
 136 static unsigned int p_ids;
 137
 138 /**
 139  * Is the setup initialized?
 140  */
 141 static int initialized;
 142
 143 /**
 144  * Number of payload packes sent.
 145  */
 146 static int data_sent;
 147
 148 /**
 149  * Number of payload packets received.
 150  */
 151 static int data_received;
 152
 153 /**
 154  * Number of payload packed acknowledgements sent.
 155  */
 156 static int ack_sent;
 157
 158 /**
 159  * Number of payload packed explicitly (app level) acknowledged.
 160  */
 161 static int ack_received;
 162
 163 /**
 164  * Total number of peers asked to run.
 165  */
 166 static unsigned long long peers_requested;
 167
 168 /**
 169  * Number of currently running peers (should be same as @c peers_requested).
 170  */
 171 static unsigned long long peers_running;
 172
 173 /**
 174  * Test context (to shut down).
 175  */
 176 struct GNUNET_CADET_TEST_Context *test_ctx;
 177
 178 /**
 179  * Task called to disconnect peers.
 180  */
 181 static struct GNUNET_SCHEDULER_Task *disconnect_task;
 182
 183 /**
 184  * Task called to reconnect peers.
 185  */
 186 static struct GNUNET_SCHEDULER_Task *reconnect_task;
 187
 188 /**
 189  * Task To perform tests
 190  */
 191 static struct GNUNET_SCHEDULER_Task *test_task;
 192
 193 /**
 194  * Task runnining #send_next_msg().
 195  */
 196 static struct GNUNET_SCHEDULER_Task *send_next_msg_task;
 197
 198 /**
 199  * Cadet handle for the root peer
 200  */
 201 static struct GNUNET_CADET_Handle *h1;
 202
 203 /**
 204  * Cadet handle for the first leaf peer
 205  */
 206 static struct GNUNET_CADET_Handle *h2;
 207
 208 /**
 209  * Channel handle for the root peer
 210  */
 211 static struct GNUNET_CADET_Channel *outgoing_ch;
 212
 213 /**
 214  * Channel handle for the dest peer
 215  */
 216 static struct GNUNET_CADET_Channel *incoming_ch;
 217
 218 /**
 219  * Time we started the data transmission (after channel has been established
 220  * and initilized).
 221  */
 222 static struct GNUNET_TIME_Absolute start_time;
 223
 224 /**
 225  * Peers handle.
 226  */
 227 static struct GNUNET_TESTBED_Peer **testbed_peers;
 228
 229 /**
 230  * Statistics operation handle.
 231  */
 232 static struct GNUNET_TESTBED_Operation *stats_op;
 233
 234 /**
 235  * Keepalives sent.
 236  */
 237 static unsigned int ka_sent;
 238
 239 /**
 240  * Keepalives received.
 241  */
 242 static unsigned int ka_received;
 243
 244 /**
 245  * How many messages were dropped by CADET because of full buffers?
 246  */
 247 static unsigned int msg_dropped;
 248
 249
 250 /******************************************************************************/
 251
 252
 253 /******************************************************************************/
 254
 255
 256 /**
 257  * Get the channel considered as the "target" or "receiver", depending on
 258  * the test type and size.
 259  *
 260  * @return Channel handle of the target client, either 0 (for backward tests)
 261  *         or the last peer in the line (for other tests).
 262  */
 263 static struct GNUNET_CADET_Channel *
 264 get_target_channel ()
 265 {
 266   if ((SPEED == test) && (GNUNET_YES == test_backwards))
 267     return outgoing_ch;
 268   else
 269     return incoming_ch;
 270 }
 271
 272
 273 /**
 274  * Show the results of the test (banwidth acheived) and log them to GAUGER
 275  */
 276 static void
 277 show_end_data (void)
 278 {
 279   static struct GNUNET_TIME_Absolute end_time;
 280   static struct GNUNET_TIME_Relative total_time;
 281
 282   end_time = GNUNET_TIME_absolute_get ();
 283   total_time = GNUNET_TIME_absolute_get_difference (start_time, end_time);
 284   fprintf (stderr,
 285            "\nResults of test \"%s\"\n",
 286            test_name);
 287   fprintf (stderr,
 288            "Test time %s\n",
 289            GNUNET_STRINGS_relative_time_to_string (total_time, GNUNET_YES));
 290   fprintf (stderr,
 291            "Test bandwidth: %f kb/s\n",
 292            4 * total_packets * 1.0 / (total_time.rel_value_us / 1000));    // 4bytes * ms
 293   fprintf (stderr,
 294            "Test throughput: %f packets/s\n\n",
 295            total_packets * 1000.0 / (total_time.rel_value_us / 1000));     // packets * ms
 296   GAUGER ("CADET",
 297           test_name,
 298           total_packets * 1000.0 / (total_time.rel_value_us / 1000),
 299           "packets/s");
 300 }
 301
 302
 303 /**
 304  * Disconnect from cadet services af all peers, call shutdown.
 305  *
 306  * @param cls Closure (line number from which termination was requested).
 307  * @param tc Task Context.
 308  */
 309 static void
 310 disconnect_cadet_peers (void *cls)
 311 {
 312   long line = (long) cls;
 313
 314   disconnect_task = NULL;
 315   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 316               "disconnecting cadet service of peers, called from line %ld\n",
 317               line);
 318   for (unsigned int i = 0; i < 2; i++)
 319   {
 320     GNUNET_TESTBED_operation_done (t_op[i]);
 321   }
 322   if (NULL != outgoing_ch)
 323   {
 324     GNUNET_CADET_channel_destroy (outgoing_ch);
 325     outgoing_ch = NULL;
 326   }
 327   if (NULL != incoming_ch)
 328   {
 329     GNUNET_CADET_channel_destroy (incoming_ch);
 330     incoming_ch = NULL;
 331   }
 332   GNUNET_CADET_TEST_cleanup (test_ctx);
 333   GNUNET_SCHEDULER_shutdown ();
 334 }
 335
 336
 337 /**
 338  * Shut down peergroup, clean up.
 339  *
 340  * @param cls Closure (unused).
 341  * @param tc Task Context.
 342  */
 343 static void
 344 shutdown_task (void *cls)
 345 {
 346   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 347               "Ending test.\n");
 348   if (NULL != send_next_msg_task)
 349   {
 350     GNUNET_SCHEDULER_cancel (send_next_msg_task);
 351     send_next_msg_task = NULL;
 352   }
 353   if (NULL != test_task)
 354   {
 355     GNUNET_SCHEDULER_cancel (test_task);
 356     test_task = NULL;
 357   }
 358   if (NULL != disconnect_task)
 359   {
 360     GNUNET_SCHEDULER_cancel (disconnect_task);
 361     disconnect_task =
 362       GNUNET_SCHEDULER_add_now (&disconnect_cadet_peers,
 363                                 (void *) __LINE__);
 364   }
 365 }
 366
 367
 368 /**
 369  * Stats callback. Finish the stats testbed operation and when all stats have
 370  * been iterated, shutdown the test.
 371  *
 372  * @param cls Closure (line number from which termination was requested).
 373  * @param op the operation that has been finished
 374  * @param emsg error message in case the operation has failed; will be NULL if
 375  *          operation has executed successfully.
 376  */
 377 static void
 378 stats_cont (void *cls,
 379             struct GNUNET_TESTBED_Operation *op,
 380             const char *emsg)
 381 {
 382   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 383               "KA sent: %u, KA received: %u\n",
 384               ka_sent,
 385               ka_received);
 386   if (((KEEPALIVE == test) || (REOPEN == test)) &&
 387       ((ka_sent < 2) || (ka_sent > ka_received + 1)))
 388   {
 389     GNUNET_break (0);
 390     ok--;
 391   }
 392   GNUNET_TESTBED_operation_done (stats_op);
 393
 394   if (NULL != disconnect_task)
 395     GNUNET_SCHEDULER_cancel (disconnect_task);
 396   disconnect_task = GNUNET_SCHEDULER_add_now (&disconnect_cadet_peers,
 397                                               cls);
 398 }
 399
 400
 401 /**
 402  * Process statistic values.
 403  *
 404  * @param cls closure (line number, unused)
 405  * @param peer the peer the statistic belong to
 406  * @param subsystem name of subsystem that created the statistic
 407  * @param name the name of the datum
 408  * @param value the current value
 409  * @param is_persistent #GNUNET_YES if the value is persistent, #GNUNET_NO if not
 410  * @return #GNUNET_OK to continue, #GNUNET_SYSERR to abort iteration
 411  */
 412 static int
 413 stats_iterator (void *cls,
 414                 const struct GNUNET_TESTBED_Peer *peer,
 415                 const char *subsystem,
 416                 const char *name,
 417                 uint64_t value,
 418                 int is_persistent)
 419 {
 420   static const char *s_sent = "# keepalives sent";
 421   static const char *s_recv = "# keepalives received";
 422   static const char *rdrops = "# messages dropped due to full buffer";
 423   static const char *cdrops = "# messages dropped due to slow client";
 424   uint32_t i;
 425
 426   i = GNUNET_TESTBED_get_index (peer);
 427   GNUNET_log (GNUNET_ERROR_TYPE_INFO, "STATS PEER %u - %s [%s]: %llu\n", i,
 428               subsystem, name, (unsigned long long) value);
 429   if ((0 == strncmp (s_sent, name, strlen (s_sent))) && (0 == i))
 430     ka_sent = value;
 431   if ((0 == strncmp (s_recv, name, strlen (s_recv))) && (peers_requested - 1 ==
 432                                                          i) )
 433     ka_received = value;
 434   if (0 == strncmp (rdrops, name, strlen (rdrops)))
 435     msg_dropped += value;
 436   if (0 == strncmp (cdrops, name, strlen (cdrops)))
 437     msg_dropped += value;
 438
 439   return GNUNET_OK;
 440 }
 441
 442
 443 /**
 444  * Task to gather all statistics.
 445  *
 446  * @param cls Closure (line from which the task was scheduled).
 447  */
 448 static void
 449 gather_stats_and_exit (void *cls)
 450 {
 451   long l = (long) cls;
 452
 453   disconnect_task = NULL;
 454   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 455               "gathering statistics from line %ld\n",
 456               l);
 457   if (NULL != outgoing_ch)
 458   {
 459     GNUNET_CADET_channel_destroy (outgoing_ch);
 460     outgoing_ch = NULL;
 461   }
 462   stats_op = GNUNET_TESTBED_get_statistics (peers_running,
 463                                             testbed_peers,
 464                                             "cadet",
 465                                             NULL,
 466                                             &stats_iterator,
 467                                             stats_cont,
 468                                             cls);
 469 }
 470
 471
 472 /**
 473  * Send a message on the channel with the appropriate size and payload.
 474  *
 475  * Update the appropriate *_sent counter.
 476  *
 477  * @param channel Channel to send the message on.
 478  */
 479 static void
 480 send_test_message (struct GNUNET_CADET_Channel *channel);
 481
 482 /**
 483  * Check if payload is sane (size contains payload).
 484  *
 485  * @param cls should match #ch
 486  * @param message The actual message.
 487  * @return #GNUNET_OK to keep the channel open,
 488  *         #GNUNET_SYSERR to close it (signal serious error).
 489  */
 490 static int
 491 check_data (void *cls,
 492             const struct GNUNET_MessageHeader *message);
 493
 494 /**
 495  * Function is called whenever a message is received.
 496  *
 497  * @param cls closure (set from GNUNET_CADET_connect(), peer number)
 498  * @param message the actual message
 499  */
 500 static void
 501 handle_data (void *cls,
 502              const struct GNUNET_MessageHeader *message);
 503
 504 /**
 505  * Function called whenever an MQ-channel is destroyed, unless the destruction
 506  * was requested by #GNUNET_CADET_channel_destroy.
 507  * It must NOT call #GNUNET_CADET_channel_destroy on the channel.
 508  *
 509  * It should clean up any associated state, including cancelling any pending
 510  * transmission on this channel.
 511  *
 512  * @param cls Channel closure (channel wrapper).
 513  * @param channel Connection to the other end (henceforth invalid).
 514  */
 515 static void
 516 disconnect_handler (void *cls,
 517                     const struct GNUNET_CADET_Channel *channel);
 518
 519
 520 /**
 521  * Task to reconnect to other peer.
 522  *
 523  * @param cls Closure (line from which the task was scheduled).
 524  */
 525 static void
 526 reconnect_op (void *cls)
 527 {
 528   struct GNUNET_MQ_MessageHandler handlers[] = {
 529     GNUNET_MQ_hd_var_size (data,
 530                            GNUNET_MESSAGE_TYPE_DUMMY,
 531                            struct GNUNET_MessageHeader,
 532                            NULL),
 533     GNUNET_MQ_handler_end ()
 534   };
 535   long l = (long) cls;
 536   struct CadetTestChannelWrapper *ch;
 537
 538   reconnect_task = NULL;
 539   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 540               "reconnecting from line %ld\n",
 541               l);
 542   if (NULL != outgoing_ch)
 543   {
 544     GNUNET_CADET_channel_destroy (outgoing_ch);
 545     outgoing_ch = NULL;
 546   }
 547   ch = GNUNET_new (struct CadetTestChannelWrapper);
 548   outgoing_ch = GNUNET_CADET_channel_create (h1,
 549                                              ch,
 550                                              p_id[1],
 551                                              &port,
 552                                              NULL,
 553                                              &disconnect_handler,
 554                                              handlers);
 555   ch->ch = outgoing_ch;
 556   send_test_message (outgoing_ch);
 557 }
 558
 559
 560 /**
 561  * Function called whenever an MQ-channel is destroyed, unless the destruction
 562  * was requested by #GNUNET_CADET_channel_destroy.
 563  * It must NOT call #GNUNET_CADET_channel_destroy on the channel.
 564  *
 565  * It should clean up any associated state, including cancelling any pending
 566  * transmission on this channel.
 567  *
 568  * @param cls Channel closure (channel wrapper).
 569  * @param channel Connection to the other end (henceforth invalid).
 570  */
 571 static void
 572 disconnect_handler (void *cls,
 573                     const struct GNUNET_CADET_Channel *channel)
 574 {
 575   struct CadetTestChannelWrapper *ch_w = cls;
 576
 577   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 578               "Channel disconnected at %d\n",
 579               ok);
 580   GNUNET_assert (ch_w->ch == channel);
 581   if (channel == incoming_ch)
 582   {
 583     ok++;
 584     incoming_ch = NULL;
 585   }
 586   else if (outgoing_ch == channel)
 587   {
 588     if (P2P_SIGNAL == test)
 589     {
 590       ok++;
 591     }
 592     outgoing_ch = NULL;
 593   }
 594   else
 595     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 596                 "Unknown channel! %p\n",
 597                 channel);
 598   if ((NULL != disconnect_task) && (REOPEN != test))
 599   {
 600     GNUNET_SCHEDULER_cancel (disconnect_task);
 601     disconnect_task =
 602       GNUNET_SCHEDULER_add_now (&gather_stats_and_exit,
 603                                 (void *) __LINE__);
 604   }
 605   else if ((NULL != reconnect_task) && (REOPEN == test))
 606   {
 607     GNUNET_SCHEDULER_cancel (reconnect_task);
 608     reconnect_task =
 609       GNUNET_SCHEDULER_add_now (&reconnect_op,
 610                                 (void *) __LINE__);
 611   }
 612   GNUNET_free (ch_w);
 613 }
 614
 615
 616 /**
 617  * Abort test: schedule disconnect and shutdown immediately
 618  *
 619  * @param line Line in the code the abort is requested from (__LINE__).
 620  */
 621 static void
 622 abort_test (long line)
 623 {
 624   if (NULL != disconnect_task)
 625   {
 626     GNUNET_SCHEDULER_cancel (disconnect_task);
 627     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 628                 "Aborting test from %ld\n",
 629                 line);
 630     disconnect_task =
 631       GNUNET_SCHEDULER_add_now (&disconnect_cadet_peers,
 632                                 (void *) line);
 633   }
 634 }
 635
 636
 637 /**
 638  * Send a message on the channel with the appropriate size and payload.
 639  *
 640  * Update the appropriate *_sent counter.
 641  *
 642  * @param channel Channel to send the message on.
 643  */
 644 static void
 645 send_test_message (struct GNUNET_CADET_Channel *channel)
 646 {
 647   struct GNUNET_MQ_Envelope *env;
 648   struct GNUNET_MessageHeader *msg;
 649   uint32_t *data;
 650   int payload;
 651   int size;
 652
 653   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 654               "Sending test message on channel %p\n",
 655               channel);
 656   size = size_payload;
 657   if (GNUNET_NO == initialized)
 658   {
 659     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Sending INITIALIZER\n");
 660     size += 1000;
 661     payload = data_sent;
 662     if (SPEED_ACK == test)   // FIXME unify SPEED_ACK with an initializer
 663       data_sent++;
 664   }
 665   else if ((SPEED == test) || (SPEED_ACK == test))
 666   {
 667     if (get_target_channel () == channel)
 668     {
 669       payload = ack_sent;
 670       size += ack_sent;
 671       ack_sent++;
 672       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 673                   "Sending ACK %u [%d bytes]\n",
 674                   payload, size);
 675     }
 676     else
 677     {
 678       payload = data_sent;
 679       size += data_sent;
 680       data_sent++;
 681       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 682                   "Sending DATA %u [%d bytes]\n",
 683                   data_sent, size);
 684     }
 685   }
 686   else if (FORWARD == test)
 687   {
 688     payload = ack_sent;
 689   }
 690   else if (P2P_SIGNAL == test)
 691   {
 692     payload = data_sent;
 693   }
 694   else if (REOPEN == test)
 695   {
 696     payload = data_sent;
 697     data_sent++;
 698     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 699                 "Sending DATA %u [%d bytes]\n",
 700                 data_sent, size);
 701   }
 702   else
 703   {
 704     GNUNET_assert (0);
 705   }
 706   env = GNUNET_MQ_msg_extra (msg, size, GNUNET_MESSAGE_TYPE_DUMMY);
 707
 708   data = (uint32_t *) &msg[1];
 709   *data = htonl (payload);
 710   GNUNET_MQ_send (GNUNET_CADET_get_mq (channel), env);
 711 }
 712
 713
 714 /**
 715  * Task to request a new data transmission in a SPEED test, without waiting
 716  * for previous messages to be sent/arrrive.
 717  *
 718  * @param cls Closure (unused).
 719  */
 720 static void
 721 send_next_msg (void *cls)
 722 {
 723   struct GNUNET_CADET_Channel *channel;
 724
 725   send_next_msg_task = NULL;
 726   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 727               "Sending next message: %d\n",
 728               data_sent);
 729
 730   channel = GNUNET_YES == test_backwards ? incoming_ch : outgoing_ch;
 731   GNUNET_assert (NULL != channel);
 732   GNUNET_assert (SPEED == test);
 733   send_test_message (channel);
 734   if (data_sent < total_packets)
 735   {
 736     /* SPEED test: Send all messages as soon as possible */
 737     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 738                 "Scheduling message %d\n",
 739                 data_sent + 1);
 740     send_next_msg_task =
 741       GNUNET_SCHEDULER_add_delayed (SEND_INTERVAL,
 742                                     &send_next_msg,
 743                                     NULL);
 744   }
 745 }
 746
 747
 748 /**
 749  * Every few messages cancel the timeout task and re-schedule it again, to
 750  * avoid timing out when traffic keeps coming.
 751  *
 752  * @param line Code line number to log if a timeout occurs.
 753  */
 754 static void
 755 reschedule_timeout_task (long line)
 756 {
 757   if ((ok % 10) == 0)
 758   {
 759     if (NULL != disconnect_task)
 760     {
 761       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 762                   "reschedule timeout every 10 messages\n");
 763       GNUNET_SCHEDULER_cancel (disconnect_task);
 764       disconnect_task = GNUNET_SCHEDULER_add_delayed (short_time,
 765                                                       &gather_stats_and_exit,
 766                                                       (void *) line);
 767     }
 768   }
 769 }
 770
 771
 772 /**
 773  * Check if payload is sane (size contains payload).
 774  *
 775  * @param cls should match #ch
 776  * @param message The actual message.
 777  * @return #GNUNET_OK to keep the channel open,
 778  *         #GNUNET_SYSERR to close it (signal serious error).
 779  */
 780 static int
 781 check_data (void *cls,
 782             const struct GNUNET_MessageHeader *message)
 783 {
 784   return GNUNET_OK;             /* all is well-formed */
 785 }
 786
 787
 788 /**
 789  * Function is called whenever a message is received.
 790  *
 791  * @param cls closure (set from GNUNET_CADET_connect(), peer number)
 792  * @param message the actual message
 793  */
 794 static void
 795 handle_data (void *cls,
 796              const struct GNUNET_MessageHeader *message)
 797 {
 798   struct CadetTestChannelWrapper *ch = cls;
 799   struct GNUNET_CADET_Channel *channel = ch->ch;
 800   uint32_t *data;
 801   uint32_t payload;
 802   int *counter;
 803
 804   ok++;
 805   GNUNET_CADET_receive_done (channel);
 806   counter = get_target_channel () == channel ? &data_received : &ack_received;
 807
 808   reschedule_timeout_task ((long) __LINE__);
 809
 810   if (channel == outgoing_ch)
 811   {
 812     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 813                 "Root client got a message.\n");
 814   }
 815   else if (channel == incoming_ch)
 816   {
 817     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 818                 "Leaf client got a message.\n");
 819   }
 820   else
 821   {
 822     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 823                 "Unknown channel %p.\n",
 824                 channel);
 825     GNUNET_assert (0);
 826   }
 827
 828   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 829               " ok: (%d/%d)\n",
 830               ok,
 831               ok_goal);
 832   data = (uint32_t *) &message[1];
 833   payload = ntohl (*data);
 834   if (payload == *counter)
 835   {
 836     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 837                 " payload as expected: %u\n",
 838                 payload);
 839   }
 840   else
 841   {
 842     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 843                 " payload %u, expected: %u\n",
 844                 payload, *counter);
 845   }
 846
 847   if (GNUNET_NO == initialized)
 848   {
 849     initialized = GNUNET_YES;
 850     start_time = GNUNET_TIME_absolute_get ();
 851     if (SPEED == test)
 852     {
 853       GNUNET_assert (incoming_ch == channel);
 854       send_next_msg_task = GNUNET_SCHEDULER_add_now (&send_next_msg,
 855                                                      NULL);
 856       return;
 857     }
 858   }
 859
 860   (*counter)++;
 861   if (get_target_channel () == channel)  /* Got "data" */
 862   {
 863     GNUNET_log (GNUNET_ERROR_TYPE_INFO, " received data %u\n", data_received);
 864     if ((SPEED != test) || ( (ok_goal - 2) == ok) )
 865     {
 866       /* Send ACK */
 867       send_test_message (channel);
 868       return;
 869     }
 870     else
 871     {
 872       if (data_received < total_packets)
 873         return;
 874     }
 875   }
 876   else /* Got "ack" */
 877   {
 878     if ((SPEED_ACK == test) || (SPEED == test) )
 879     {
 880       GNUNET_log (GNUNET_ERROR_TYPE_INFO, " received ack %u\n", ack_received);
 881       /* Send more data */
 882       send_test_message (channel);
 883       if ((ack_received < total_packets) && (SPEED != test) )
 884         return;
 885       if ((ok == 2) && (SPEED == test) )
 886         return;
 887       show_end_data ();
 888     }
 889     if (test == P2P_SIGNAL)
 890     {
 891       GNUNET_CADET_channel_destroy (incoming_ch);
 892       incoming_ch = NULL;
 893     }
 894     else
 895     {
 896       GNUNET_CADET_channel_destroy (outgoing_ch);
 897       outgoing_ch = NULL;
 898     }
 899   }
 900 }
 901
 902
 903 /**
 904  * Method called whenever a peer connects to a port in MQ-based CADET.
 905  *
 906  * @param cls Closure from #GNUNET_CADET_open_port (peer # as long).
 907  * @param channel New handle to the channel.
 908  * @param source Peer that started this channel.
 909  * @return Closure for the incoming @a channel. It's given to:
 910  *         - The #GNUNET_CADET_DisconnectEventHandler (given to
 911  *           #GNUNET_CADET_open_port) when the channel dies.
 912  *         - Each the #GNUNET_MQ_MessageCallback handlers for each message
 913  *           received on the @a channel.
 914  */
 915 static void *
 916 connect_handler (void *cls,
 917                  struct GNUNET_CADET_Channel *channel,
 918                  const struct GNUNET_PeerIdentity *source)
 919 {
 920   struct CadetTestChannelWrapper *ch;
 921   long peer = (long) cls;
 922
 923   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 924               "Incoming channel from %s to %ld: %p\n",
 925               GNUNET_i2s (source),
 926               peer,
 927               channel);
 928   ok++;
 929   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 930               " ok: %d\n",
 931               ok);
 932   if (peer == peers_requested - 1)
 933   {
 934     if (NULL != incoming_ch)
 935     {
 936       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 937                   "Duplicate incoming channel for client %lu\n",
 938                   (long) cls);
 939       GNUNET_assert (0);
 940     }
 941     incoming_ch = channel;
 942   }
 943   else
 944   {
 945     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 946                 "Incoming channel for unexpected peer #%lu\n",
 947                 (long) cls);
 948     GNUNET_assert (0);
 949   }
 950   if ((NULL != disconnect_task) && (REOPEN != test))
 951   {
 952     GNUNET_SCHEDULER_cancel (disconnect_task);
 953     disconnect_task = GNUNET_SCHEDULER_add_delayed (short_time,
 954                                                     &gather_stats_and_exit,
 955                                                     (void *) __LINE__);
 956   }
 957   else if ((NULL != disconnect_task) && (REOPEN == test))
 958   {
 959     GNUNET_SCHEDULER_cancel (disconnect_task);
 960     disconnect_task = GNUNET_SCHEDULER_add_delayed (
 961       GNUNET_TIME_relative_multiply (short_time, 2),
 962       &gather_stats_and_exit,
 963       (void *) __LINE__);
 964   }
 965
 966   if ((NULL != reconnect_task) && (REOPEN == test))
 967   {
 968     GNUNET_SCHEDULER_cancel (reconnect_task);
 969     reconnect_task = GNUNET_SCHEDULER_add_delayed (short_time,
 970                                                    &reconnect_op,
 971                                                    (void *) __LINE__);
 972   }
 973
 974   /* TODO: cannot return channel as-is, in order to unify the data handlers */
 975   ch = GNUNET_new (struct CadetTestChannelWrapper);
 976   ch->ch = channel;
 977
 978   return ch;
 979 }
 980
 981
 982 /**
 983  * START THE TESTCASE ITSELF, AS WE ARE CONNECTED TO THE CADET SERVICES.
 984  *
 985  * Testcase continues when the root receives confirmation of connected peers,
 986  * on callback function ch.
 987  *
 988  * @param cls Closure (unused).
 989  */
 990 static void
 991 start_test (void *cls)
 992 {
 993   struct GNUNET_MQ_MessageHandler handlers[] = {
 994     GNUNET_MQ_hd_var_size (data,
 995                            GNUNET_MESSAGE_TYPE_DUMMY,
 996                            struct GNUNET_MessageHeader,
 997                            NULL),
 998     GNUNET_MQ_handler_end ()
 999   };
1000   struct CadetTestChannelWrapper *ch;
1001
1002   test_task = NULL;
1003   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "start_test: %s\n", test_name);
1004   if (NULL != disconnect_task)
1005   {
1006     GNUNET_SCHEDULER_cancel (disconnect_task);
1007     disconnect_task = NULL;
1008   }
1009
1010   if (SPEED_REL == test)
1011   {
1012     test = SPEED;
1013   }
1014
1015   ch = GNUNET_new (struct CadetTestChannelWrapper);
1016   outgoing_ch = GNUNET_CADET_channel_create (h1,
1017                                              ch,
1018                                              p_id[1],
1019                                              &port,
1020                                              NULL,
1021                                              &disconnect_handler,
1022                                              handlers);
1023
1024   ch->ch = outgoing_ch;
1025
1026   disconnect_task = GNUNET_SCHEDULER_add_delayed (short_time,
1027                                                   &gather_stats_and_exit,
1028                                                   (void *) __LINE__);
1029   if (KEEPALIVE == test)
1030     return;                     /* Don't send any data. */
1031
1032   data_received = 0;
1033   data_sent = 0;
1034   ack_received = 0;
1035   ack_sent = 0;
1036   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1037               "Sending data initializer on channel %p...\n",
1038               outgoing_ch);
1039   send_test_message (outgoing_ch);
1040   if (REOPEN == test)
1041   {
1042     reconnect_task = GNUNET_SCHEDULER_add_delayed (short_time,
1043                                                    &reconnect_op,
1044                                                    (void *) __LINE__);
1045     GNUNET_SCHEDULER_cancel (disconnect_task);
1046     disconnect_task = GNUNET_SCHEDULER_add_delayed (
1047       GNUNET_TIME_relative_multiply (short_time, 2),
1048       &gather_stats_and_exit,
1049       (void *) __LINE__);
1050   }
1051 }
1052
1053
1054 /**
1055  * Callback to be called when the requested peer information is available
1056  *
1057  * @param cls the closure from GNUNET_TESTBED_peer_get_information()
1058  * @param op the operation this callback corresponds to
1059  * @param pinfo the result; will be NULL if the operation has failed
1060  * @param emsg error message if the operation has failed;
1061  *             NULL if the operation is successfull
1062  */
1063 static void
1064 pi_cb (void *cls,
1065        struct GNUNET_TESTBED_Operation *op,
1066        const struct GNUNET_TESTBED_PeerInformation *pinfo,
1067        const char *emsg)
1068 {
1069   long i = (long) cls;
1070
1071   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1072               "ID callback for %ld\n",
1073               i);
1074   if ((NULL == pinfo) ||
1075       (NULL != emsg))
1076   {
1077     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1078                 "pi_cb: %s\n",
1079                 emsg);
1080     abort_test (__LINE__);
1081     return;
1082   }
1083   p_id[i] = pinfo->result.id;
1084   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1085               "id: %s\n",
1086               GNUNET_i2s (p_id[i]));
1087   p_ids++;
1088   if (p_ids < 2)
1089     return;
1090   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1091               "Got all IDs, starting test\n");
1092   test_task = GNUNET_SCHEDULER_add_now (&start_test, NULL);
1093 }
1094
1095
1096 /**
1097  * test main: start test when all peers are connected
1098  *
1099  * @param cls Closure.
1100  * @param ctx Argument to give to GNUNET_CADET_TEST_cleanup on test end.
1101  * @param num_peers Number of peers that are running.
1102  * @param peers Array of peers.
1103  * @param cadets Handle to each of the CADETs of the peers.
1104  */
1105 static void
1106 tmain (void *cls,
1107        struct GNUNET_CADET_TEST_Context *ctx,
1108        unsigned int num_peers,
1109        struct GNUNET_TESTBED_Peer **peers,
1110        struct GNUNET_CADET_Handle **cadets)
1111 {
1112   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test main\n");
1113   ok = 0;
1114   test_ctx = ctx;
1115   peers_running = num_peers;
1116   GNUNET_assert (peers_running == peers_requested);
1117   testbed_peers = peers;
1118   h1 = cadets[0];
1119   h2 = cadets[num_peers - 1];
1120   disconnect_task = GNUNET_SCHEDULER_add_delayed (short_time,
1121                                                   &disconnect_cadet_peers,
1122                                                   (void *) __LINE__);
1123   GNUNET_SCHEDULER_add_shutdown (&shutdown_task,
1124                                  NULL);
1125   t_op[0] = GNUNET_TESTBED_peer_get_information (peers[0],
1126                                                  GNUNET_TESTBED_PIT_IDENTITY,
1127                                                  &pi_cb,
1128                                                  (void *) 0L);
1129   t_op[1] = GNUNET_TESTBED_peer_get_information (peers[num_peers - 1],
1130                                                  GNUNET_TESTBED_PIT_IDENTITY,
1131                                                  &pi_cb,
1132                                                  (void *) 1L);
1133   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "requested peer ids\n");
1134 }
1135
1136
1137 /**
1138  * Main: start test
1139  */
1140 int
1141 main (int argc, char *argv[])
1142 {
1143   static const struct GNUNET_HashCode *ports[2];
1144   struct GNUNET_MQ_MessageHandler handlers[] = {
1145     GNUNET_MQ_hd_var_size (data,
1146                            GNUNET_MESSAGE_TYPE_DUMMY,
1147                            struct GNUNET_MessageHeader,
1148                            NULL),
1149     GNUNET_MQ_handler_end ()
1150   };
1151   const char *config_file;
1152   char port_id[] = "test port";
1153   struct GNUNET_GETOPT_CommandLineOption options[] = {
1154     GNUNET_GETOPT_option_relative_time ('t',
1155                                         "time",
1156                                         "short_time",
1157                                         gettext_noop ("set short timeout"),
1158                                         &short_time),
1159     GNUNET_GETOPT_option_uint ('m',
1160                                "messages",
1161                                "NUM_MESSAGES",
1162                                gettext_noop ("set number of messages to send"),
1163                                &total_packets),
1164
1165     GNUNET_GETOPT_OPTION_END
1166   };
1167
1168
1169   initialized = GNUNET_NO;
1170   GNUNET_log_setup ("test", "DEBUG", NULL);
1171
1172   total_packets = TOTAL_PACKETS;
1173   short_time = SHORT_TIME;
1174   if (-1 == GNUNET_GETOPT_run (argv[0], options, argc, argv))
1175   {
1176     fprintf (stderr, "test failed: problem with CLI parameters\n");
1177     exit (1);
1178   }
1179
1180   config_file = "test_cadet.conf";
1181   GNUNET_CRYPTO_hash (port_id, sizeof(port_id), &port);
1182
1183   /* Find out requested size */
1184   if (strstr (argv[0], "_2_") != NULL)
1185   {
1186     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "DIRECT CONNECTIONs\n");
1187     peers_requested = 2;
1188   }
1189   else if (strstr (argv[0], "_5_") != NULL)
1190   {
1191     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "5 PEER LINE\n");
1192     peers_requested = 5;
1193   }
1194   else if (strstr (argv[0], "_6_") != NULL)
1195   {
1196     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "6 PEER LINE\n");
1197     peers_requested = 6;
1198   }
1199   else
1200   {
1201     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "SIZE UNKNOWN, USING 2\n");
1202     peers_requested = 2;
1203   }
1204
1205   /* Find out requested test */
1206   if (strstr (argv[0], "_forward") != NULL)
1207   {
1208     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "FORWARD\n");
1209     test = FORWARD;
1210     test_name = "unicast";
1211     ok_goal = 4;
1212   }
1213   else if (strstr (argv[0], "_signal") != NULL)
1214   {
1215     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "SIGNAL\n");
1216     test = P2P_SIGNAL;
1217     test_name = "signal";
1218     ok_goal = 4;
1219   }
1220   else if (strstr (argv[0], "_speed_ack") != NULL)
1221   {
1222     /* Test is supposed to generate the following callbacks:
1223      * 1 incoming channel (@dest)
1224      * total_packets received data packet (@dest)
1225      * total_packets received data packet (@orig)
1226      * 1 received channel destroy (@dest) FIXME #5818
1227      */ok_goal = total_packets * 2 + 2;
1228     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "SPEED_ACK\n");
1229     test = SPEED_ACK;
1230     test_name = "speed ack";
1231   }
1232   else if (strstr (argv[0], "_speed") != NULL)
1233   {
1234     /* Test is supposed to generate the following callbacks:
1235      * 1 incoming channel (@dest)
1236      * 1 initial packet (@dest)
1237      * total_packets received data packet (@dest)
1238      * 1 received data packet (@orig)
1239      * 1 received channel destroy (@dest)  FIXME #5818
1240      */ok_goal = total_packets + 4;
1241     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "SPEED\n");
1242     if (strstr (argv[0], "_reliable") != NULL)
1243     {
1244       test = SPEED_REL;
1245       test_name = "speed reliable";
1246       config_file = "test_cadet_drop.conf";
1247     }
1248     else
1249     {
1250       test = SPEED;
1251       test_name = "speed";
1252     }
1253   }
1254   else if (strstr (argv[0], "_keepalive") != NULL)
1255   {
1256     test = KEEPALIVE;
1257     test_name = "keepalive";
1258     /* Test is supposed to generate the following callbacks:
1259      * 1 incoming channel (@dest)
1260      * [wait]
1261      * 1 received channel destroy (@dest)  FIXME #5818
1262      */ok_goal = 1;
1263   }
1264   else if (strstr (argv[0], "_reopen") != NULL)
1265   {
1266     test = REOPEN;
1267     test_name = "reopen";
1268     ///* Test is supposed to generate the following callbacks:
1269     // * 1 incoming channel (@dest)
1270     // * [wait]
1271     // * 1 received channel destroy (@dest)  FIXME #5818
1272     // */
1273     ok_goal = 6;
1274   }
1275   else
1276   {
1277     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "UNKNOWN\n");
1278     test = SETUP;
1279     ok_goal = 0;
1280   }
1281
1282   if (strstr (argv[0], "backwards") != NULL)
1283   {
1284     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "BACKWARDS (LEAF TO ROOT)\n");
1285     test_backwards = GNUNET_YES;
1286     GNUNET_asprintf (&test_name, "backwards %s", test_name);
1287   }
1288
1289   p_ids = 0;
1290   ports[0] = &port;
1291   ports[1] = NULL;
1292   GNUNET_CADET_TEST_ruN ("test_cadet_small",
1293                          config_file,
1294                          peers_requested,
1295                          &tmain,
1296                          NULL,        /* tmain cls */
1297                          &connect_handler,
1298                          NULL,
1299                          &disconnect_handler,
1300                          handlers,
1301                          ports);
1302   if (NULL != strstr (argv[0], "_reliable"))
1303     msg_dropped = 0;            /* dropped should be retransmitted */
1304
1305   if (ok_goal > ok - msg_dropped)
1306   {
1307     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "FAILED! (%d/%d)\n", ok, ok_goal);
1308     return 1;
1309   }
1310   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "success\n");
1311   return 0;
1312 }
1313
1314
1315 /* end of test_cadet.c */