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, uint32_t ats_count)
 165 {
 166   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 167               "Received message of type %d from peer %s!\n",
 168               ntohs (message->type), GNUNET_i2s (peer));
 169 }
 170
 171 static void
 172 notify_connect (void *cls, const struct GNUNET_PeerIdentity *peer,
 173                 const struct GNUNET_ATS_Information *ats, uint32_t ats_count)
 174 {
 175   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer `%4s' connected to us (%p)!\n",
 176               GNUNET_i2s (peer), cls);
 177 }
 178
 179
 180 static void
 181 notify_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
 182 {
 183   if (shutdown_flag != GNUNET_YES)
 184   {
 185     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 186                 "FAIL! Peer `%4s' disconnected during waiting period!\n",
 187                 GNUNET_i2s (peer));
 188     disconnects++;
 189   }
 190   if (th != NULL)
 191     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
 192   th = NULL;
 193 }
 194
 195 static void
 196 timer (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 197 {
 198   static int percentage;
 199
 200   timer_task = GNUNET_SCHEDULER_NO_TASK;
 201
 202   if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
 203     return;
 204
 205   percentage += 10;
 206   time_running =
 207       GNUNET_TIME_relative_add (time_running,
 208                                 GNUNET_TIME_relative_divide (WAIT, 10));
 209
 210   if (time_running.rel_value ==
 211       GNUNET_TIME_relative_max (time_running, WAIT).rel_value)
 212   {
 213     FPRINTF (stderr, "%s",  "100%%\n");
 214     shutdown_flag = GNUNET_YES;
 215     GNUNET_SCHEDULER_add_now (&end, NULL);
 216   }
 217   else
 218   {
 219     FPRINTF (stderr, "%u%%..", percentage);
 220     timer_task =
 221         GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_divide (WAIT, 10),
 222                                       &timer, NULL);
 223   }
 224 }
 225
 226 static void
 227 testing_connect_cb (struct PeerContext *p1, struct PeerContext *p2, void *cls)
 228 {
 229   cc = NULL;
 230   char *p1_c = GNUNET_strdup (GNUNET_i2s (&p1->id));
 231
 232   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peers connected: %s <-> %s\n", p1_c,
 233               GNUNET_i2s (&p2->id));
 234   GNUNET_free (p1_c);
 235
 236   shutdown_flag = GNUNET_NO;
 237
 238   timer_task = GNUNET_SCHEDULER_add_now (&timer, NULL);
 239 }
 240
 241 void
 242 start_cb (struct PeerContext *p, void *cls)
 243 {
 244   static int started;
 245
 246   started++;
 247
 248   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer %u (`%s') started\n", p->no,
 249               GNUNET_i2s (&p->id));
 250
 251   if (started != 2)
 252     return;
 253
 254   char *sender_c = GNUNET_strdup (GNUNET_i2s (&p1->id));
 255
 256   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 257               "Test tries to connect peer %u (`%s') -> peer %u (`%s')\n",
 258               p1->no, sender_c, p2->no, GNUNET_i2s (&p2->id));
 259
 260   cc = GNUNET_TRANSPORT_TESTING_connect_peers (tth, p1, p2, &testing_connect_cb,
 261                                                NULL);
 262
 263 }
 264
 265 static void
 266 run (void *cls, char *const *args, const char *cfgfile,
 267      const struct GNUNET_CONFIGURATION_Handle *cfg)
 268 {
 269   die_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly, NULL);
 270
 271   p1 = GNUNET_TRANSPORT_TESTING_start_peer (tth, cfg_file_p1, 1,
 272                                             &notify_receive, &notify_connect,
 273                                             &notify_disconnect, &start_cb,
 274                                             NULL);
 275   p2 = GNUNET_TRANSPORT_TESTING_start_peer (tth, cfg_file_p2, 2,
 276                                             &notify_receive, &notify_connect,
 277                                             &notify_disconnect, &start_cb,
 278                                             NULL);
 279
 280   if ((p1 == NULL) || (p2 == NULL))
 281   {
 282     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Fail! Could not start peers!\n");
 283     if (die_task != GNUNET_SCHEDULER_NO_TASK)
 284       GNUNET_SCHEDULER_cancel (die_task);
 285     die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
 286     return;
 287   }
 288 }
 289
 290 static int
 291 check ()
 292 {
 293   static char *const argv[] = { "test-transport-api-timeout",
 294     "-c",
 295     "test_transport_api_data.conf",
 296 #if VERBOSE
 297     "-L", "DEBUG",
 298 #endif
 299     NULL
 300   };
 301   static struct GNUNET_GETOPT_CommandLineOption options[] = {
 302     GNUNET_GETOPT_OPTION_END
 303   };
 304
 305 #if WRITECONFIG
 306   setTransportOptions ("test_transport_api_data.conf");
 307 #endif
 308   timer_task = GNUNET_SCHEDULER_NO_TASK;
 309
 310   ok = 1;
 311   GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1, argv,
 312                       "test-transport-api-timeout", "nohelp", options, &run,
 313                       &ok);
 314
 315   return ok;
 316 }
 317
 318 int
 319 main (int argc, char *argv[])
 320 {
 321   int ret;
 322   int nat_res;
 323
 324   GNUNET_TRANSPORT_TESTING_get_test_name (argv[0], &test_name);
 325
 326   GNUNET_log_setup (test_name,
 327 #if VERBOSE
 328                     "DEBUG",
 329 #else
 330                     "WARNING",
 331 #endif
 332                     NULL);
 333
 334   GNUNET_TRANSPORT_TESTING_get_test_source_name (__FILE__, &test_source);
 335   GNUNET_TRANSPORT_TESTING_get_test_plugin_name (argv[0], test_source,
 336                                                  &test_plugin);
 337
 338   tth = GNUNET_TRANSPORT_TESTING_init ();
 339
 340   if ((strcmp (test_plugin, "tcp_nat") == 0) ||
 341       (strcmp (test_plugin, "udp_nat") == 0))
 342   {
 343     nat_res = GNUNET_OS_check_helper_binary ("gnunet-nat-server");
 344     if (GNUNET_NO == nat_res)
 345     {
 346       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Cannot run NAT test: `%s' %s \n",
 347                   "gnunet-nat-server", "SUID not set");
 348       return 0;
 349     }
 350     if (GNUNET_SYSERR == nat_res)
 351     {
 352       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Cannot run NAT test: `%s' %s \n",
 353                   "gnunet-nat-server", "file not found");
 354       return 0;
 355     }
 356   }
 357
 358   GNUNET_TRANSPORT_TESTING_get_config_name (argv[0], &cfg_file_p1, 1);
 359   GNUNET_TRANSPORT_TESTING_get_config_name (argv[0], &cfg_file_p2, 2);
 360
 361   ret = check ();
 362
 363   GNUNET_free (cfg_file_p1);
 364   GNUNET_free (cfg_file_p2);
 365
 366   GNUNET_free (test_source);
 367   GNUNET_free (test_plugin);
 368   GNUNET_free (test_name);
 369
 370
 371   return ret;
 372 }
 373
 374 /* end of test_transport_api_timeout.c*/