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