src/transport/test_transport_api_timeout.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 transport/test_transport_api_timeout.c
  22  * @brief test case for transport plugin implementations complying timeout
  23  * settings
  24  *
  25  *
  26  * This test case serves ensures that no peer disconnect events occurs
  27  * while plugins are idle
  28  */
  29
  30 #include "platform.h"
  31 #include "gnunet_common.h"
  32 #include "gnunet_hello_lib.h"
  33 #include "gnunet_getopt_lib.h"
  34 #include "gnunet_os_lib.h"
  35 #include "gnunet_program_lib.h"
  36 #include "gnunet_scheduler_lib.h"
  37 #include "gnunet_transport_service.h"
  38 #include "transport.h"
  39 #include "transport-testing.h"
  40
  41 #define VERBOSE GNUNET_EXTRA_LOGGING
  42
  43 #define VERBOSE_ARM GNUNET_EXTRA_LOGGING
  44
  45 #define START_ARM GNUNET_YES
  46
  47 /**
  48  * How long until we give up on transmitting the message?
  49  */
  50 #define WAIT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
  51
  52 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 90)
  53
  54 #define MTYPE 12345
  55
  56 static char *test_source;
  57
  58 static char *test_plugin;
  59
  60 static char *test_name;
  61
  62 static int ok;
  63
  64 static GNUNET_SCHEDULER_TaskIdentifier die_task;
  65
  66 static GNUNET_SCHEDULER_TaskIdentifier timer_task;
  67
  68 struct GNUNET_TRANSPORT_TESTING_handle * tth;
  69
  70 struct PeerContext *p1;
  71
  72 struct PeerContext *p2;
  73
  74 static GNUNET_TRANSPORT_TESTING_ConnectRequest cc;
  75
  76 struct GNUNET_TRANSPORT_TransmitHandle *th;
  77
  78 char *cfg_file_p1;
  79
  80 char *cfg_file_p2;
  81
  82 static struct GNUNET_TIME_Relative time_running;
  83
  84 static int shutdown_flag;
  85
  86 static int disconnects;
  87
  88
  89 #if VERBOSE
  90 #define OKPP do { ok++; fprintf (stderr, "Now at stage %u at %s:%u\n", ok, __FILE__, __LINE__); } while (0)
  91 #else
  92 #define OKPP do { ok++; } while (0)
  93 #endif
  94
  95
  96 static void
  97 end ()
  98 {
  99   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Stopping peers\n");
 100
 101   if (timer_task != GNUNET_SCHEDULER_NO_TASK)
 102   {
 103     GNUNET_SCHEDULER_cancel (timer_task);
 104     timer_task = GNUNET_SCHEDULER_NO_TASK;
 105   }
 106
 107   if (die_task != GNUNET_SCHEDULER_NO_TASK)
 108   {
 109     GNUNET_SCHEDULER_cancel (die_task);
 110     die_task = GNUNET_SCHEDULER_NO_TASK;
 111   }
 112
 113   if (th != NULL)
 114     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
 115   th = NULL;
 116
 117
 118   GNUNET_TRANSPORT_TESTING_stop_peer (tth, p1);
 119   GNUNET_TRANSPORT_TESTING_stop_peer (tth, p2);
 120
 121   if (disconnects == 0)
 122     ok = 0;
 123   else
 124   {
 125     ok = disconnects;
 126     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 127                 "Fail! Had %u disconnects while waiting %llu seconds \n",
 128                 disconnects, WAIT.rel_value);
 129   }
 130
 131   GNUNET_TRANSPORT_TESTING_done (tth);
 132 }
 133
 134 static void
 135 end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 136 {
 137   die_task = GNUNET_SCHEDULER_NO_TASK;
 138
 139   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Fail! Stopping peers\n");
 140
 141   if (timer_task != GNUNET_SCHEDULER_NO_TASK)
 142   {
 143     GNUNET_SCHEDULER_cancel (timer_task);
 144     timer_task = GNUNET_SCHEDULER_NO_TASK;
 145   }
 146   if (cc != NULL)
 147     GNUNET_TRANSPORT_TESTING_connect_peers_cancel (tth, cc);
 148   if (th != NULL)
 149     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
 150   th = NULL;
 151   if (p1 != NULL)
 152     GNUNET_TRANSPORT_TESTING_stop_peer (tth, p1);
 153   if (p2 != NULL)
 154     GNUNET_TRANSPORT_TESTING_stop_peer (tth, p2);
 155   ok = GNUNET_SYSERR;
 156
 157   GNUNET_TRANSPORT_TESTING_done (tth);
 158 }
 159
 160
 161 static void
 162 notify_receive (void *cls, const struct GNUNET_PeerIdentity *peer,
 163                 const struct GNUNET_MessageHeader *message,
 164                 const struct GNUNET_ATS_Information *ats,
 165                 uint32_t ats_count)
 166 {
 167   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 168               "Received message of type %d from peer %s!\n",
 169               ntohs (message->type), GNUNET_i2s (peer));
 170 }
 171
 172 static void
 173 notify_connect (void *cls, const struct GNUNET_PeerIdentity *peer,
 174                 const struct GNUNET_ATS_Information *ats,
 175                 uint32_t ats_count)
 176 {
 177   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer `%4s' connected to us (%p)!\n",
 178               GNUNET_i2s (peer), cls);
 179 }
 180
 181
 182 static void
 183 notify_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
 184 {
 185   if (shutdown_flag != GNUNET_YES)
 186   {
 187     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 188                 "FAIL! Peer `%4s' disconnected during waiting period!\n",
 189                 GNUNET_i2s (peer));
 190     disconnects++;
 191   }
 192   if (th != NULL)
 193     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
 194   th = NULL;
 195 }
 196
 197 static void
 198 timer (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 199 {
 200   static int percentage;
 201
 202   timer_task = GNUNET_SCHEDULER_NO_TASK;
 203
 204   if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
 205     return;
 206
 207   percentage += 10;
 208   time_running =
 209       GNUNET_TIME_relative_add (time_running,
 210                                 GNUNET_TIME_relative_divide (WAIT, 10));
 211
 212   if (time_running.rel_value ==
 213       GNUNET_TIME_relative_max (time_running, WAIT).rel_value)
 214   {
 215     fprintf (stderr, "100%%\n");
 216     shutdown_flag = GNUNET_YES;
 217     GNUNET_SCHEDULER_add_now (&end, NULL);
 218   }
 219   else
 220   {
 221     fprintf (stderr, "%u%%..", percentage);
 222     timer_task =
 223         GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_divide (WAIT, 10),
 224                                       &timer, NULL);
 225   }
 226 }
 227
 228 static void
 229 testing_connect_cb (struct PeerContext *p1, struct PeerContext *p2, void *cls)
 230 {
 231   cc = NULL;
 232   char *p1_c = strdup (GNUNET_i2s (&p1->id));
 233
 234   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peers connected: %s <-> %s\n", p1_c,
 235               GNUNET_i2s (&p2->id));
 236   GNUNET_free (p1_c);
 237
 238   shutdown_flag = GNUNET_NO;
 239
 240   timer_task = GNUNET_SCHEDULER_add_now (&timer, NULL);
 241 }
 242
 243 void start_cb (struct PeerContext * p,
 244                void *cls)
 245 {
 246   static int started;
 247   started++;
 248
 249   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer %u (`%s') started\n",
 250        p->no,
 251        GNUNET_i2s (&p->id));
 252
 253   if (started != 2)
 254     return;
 255
 256   char *sender_c = strdup (GNUNET_i2s (&p1->id));
 257   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Test tries to connect peer %u (`%s') -> peer %u (`%s')\n",
 258               p1->no, sender_c,
 259               p2->no, GNUNET_i2s (&p2->id));
 260
 261   cc = GNUNET_TRANSPORT_TESTING_connect_peers (tth, p1, p2, &testing_connect_cb,
 262                                                NULL);
 263
 264 }
 265
 266 static void
 267 run (void *cls, char *const *args, const char *cfgfile,
 268      const struct GNUNET_CONFIGURATION_Handle *cfg)
 269 {
 270   die_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly, NULL);
 271
 272   p1 = GNUNET_TRANSPORT_TESTING_start_peer (tth, cfg_file_p1,  1,
 273                                             &notify_receive,
 274                                             &notify_connect,
 275                                             &notify_disconnect,
 276                                             &start_cb,
 277                                             NULL);
 278   p2 = GNUNET_TRANSPORT_TESTING_start_peer (tth, cfg_file_p2, 2,
 279                                             &notify_receive,
 280                                             &notify_connect,
 281                                             &notify_disconnect,
 282                                             &start_cb,
 283                                             NULL);
 284
 285   if ((p1 == NULL) || (p2 == NULL))
 286   {
 287     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Fail! Could not start peers!\n");
 288     if (die_task != GNUNET_SCHEDULER_NO_TASK)
 289       GNUNET_SCHEDULER_cancel (die_task);
 290     die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
 291     return;
 292   }
 293 }
 294
 295 static int
 296 check ()
 297 {
 298   static char *const argv[] = { "test-transport-api-timeout",
 299     "-c",
 300     "test_transport_api_data.conf",
 301 #if VERBOSE
 302     "-L", "DEBUG",
 303 #endif
 304     NULL
 305   };
 306   static struct GNUNET_GETOPT_CommandLineOption options[] = {
 307     GNUNET_GETOPT_OPTION_END
 308   };
 309
 310 #if WRITECONFIG
 311   setTransportOptions ("test_transport_api_data.conf");
 312 #endif
 313   timer_task = GNUNET_SCHEDULER_NO_TASK;
 314
 315   ok = 1;
 316   GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1, argv,
 317                       "test-transport-api-timeout", "nohelp", options,
 318                       &run, &ok);
 319
 320   return ok;
 321 }
 322
 323 int
 324 main (int argc, char *argv[])
 325 {
 326   int ret;
 327   int nat_res;
 328
 329   tth = GNUNET_TRANSPORT_TESTING_init ();
 330
 331   GNUNET_TRANSPORT_TESTING_get_test_source_name (__FILE__, &test_source);
 332   GNUNET_TRANSPORT_TESTING_get_test_plugin_name (argv[0], test_source,
 333                                                  &test_plugin);
 334   GNUNET_TRANSPORT_TESTING_get_test_name (argv[0], &test_name);
 335
 336   GNUNET_log_setup (test_name,
 337 #if VERBOSE
 338                     "DEBUG",
 339 #else
 340                     "WARNING",
 341 #endif
 342                     NULL);
 343
 344   if ((strcmp (test_plugin, "tcp_nat") == 0) ||
 345       (strcmp (test_plugin, "udp_nat") == 0))
 346   {
 347     nat_res = GNUNET_OS_check_helper_binary ("gnunet-nat-server");
 348     if (GNUNET_NO == nat_res)
 349     {
 350       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Cannot run NAT test: `%s' %s \n",
 351                   "gnunet-nat-server", "SUID not set");
 352       return 0;
 353     }
 354     if (GNUNET_SYSERR == nat_res)
 355     {
 356       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Cannot run NAT test: `%s' %s \n",
 357                   "gnunet-nat-server", "file not found");
 358       return 0;
 359     }
 360   }
 361
 362   GNUNET_TRANSPORT_TESTING_get_config_name (argv[0], &cfg_file_p1, 1);
 363   GNUNET_TRANSPORT_TESTING_get_config_name (argv[0], &cfg_file_p2, 2);
 364
 365   ret = check ();
 366
 367   GNUNET_free (cfg_file_p1);
 368   GNUNET_free (cfg_file_p2);
 369
 370   GNUNET_free (test_source);
 371   GNUNET_free (test_plugin);
 372   GNUNET_free (test_name);
 373
 374
 375   return ret;
 376 }
 377
 378 /* end of test_transport_api_timeout.c*/