src/transport/test_transport_api_disconnect.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_disconnect.c
  22  * @brief base test case for transport implementations
  23  *
  24  * This test case tests disconnect notifications in peer shutdown
  25  */
  26 #include "platform.h"
  27 #include "gnunet_transport_service.h"
  28 #include "transport-testing.h"
  29
  30 /**
  31  * How long until we give up on transmitting the message?
  32  */
  33 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 120)
  34
  35 /**
  36  * How long until we give up on transmitting the message?
  37  */
  38 #define TIMEOUT_TRANSMIT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 60)
  39
  40 #define MTYPE 12345
  41
  42 static char *test_source;
  43
  44 static char *test_plugin;
  45
  46 static char *test_name;
  47
  48 static int ok;
  49
  50 static GNUNET_SCHEDULER_TaskIdentifier die_task;
  51
  52 static GNUNET_SCHEDULER_TaskIdentifier send_task;
  53
  54 struct PeerContext *p1;
  55
  56 struct PeerContext *p2;
  57
  58 static GNUNET_TRANSPORT_TESTING_ConnectRequest cc;
  59
  60 struct GNUNET_TRANSPORT_TransmitHandle *th;
  61
  62 struct GNUNET_TRANSPORT_TESTING_handle *tth;
  63
  64 int shutdown_;
  65
  66 char *cfg_file_p1;
  67
  68 char *cfg_file_p2;
  69
  70 #if VERBOSE
  71 #define OKPP do { ok++; FPRINTF (stderr, "Now at stage %u at %s:%u\n", ok, __FILE__, __LINE__); } while (0)
  72 #else
  73 #define OKPP do { ok++; } while (0)
  74 #endif
  75
  76
  77 static void
  78 end ()
  79 {
  80   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Stopping peers\n");
  81
  82   if (send_task != GNUNET_SCHEDULER_NO_TASK)
  83   {
  84     GNUNET_SCHEDULER_cancel (send_task);
  85     send_task = GNUNET_SCHEDULER_NO_TASK;
  86   }
  87
  88   if (die_task != GNUNET_SCHEDULER_NO_TASK)
  89   {
  90     GNUNET_SCHEDULER_cancel (die_task);
  91     die_task = GNUNET_SCHEDULER_NO_TASK;
  92   }
  93
  94   if (th != NULL)
  95     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
  96   th = NULL;
  97
  98   if (p1 != NULL)
  99     GNUNET_TRANSPORT_TESTING_stop_peer (tth, p1);
 100   p1 = NULL;
 101
 102   if (p2 != NULL)
 103     GNUNET_TRANSPORT_TESTING_stop_peer (tth, p2);
 104   p2 = NULL;
 105
 106   /* success */
 107   ok = 0;
 108 }
 109
 110 static void
 111 end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 112 {
 113   die_task = GNUNET_SCHEDULER_NO_TASK;
 114
 115   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Fail! Stopping peers\n");
 116
 117   if (cc != NULL)
 118   {
 119     GNUNET_TRANSPORT_TESTING_connect_peers_cancel (tth, cc);
 120     cc = NULL;
 121   }
 122
 123   if (send_task != GNUNET_SCHEDULER_NO_TASK)
 124   {
 125     GNUNET_SCHEDULER_cancel (send_task);
 126     send_task = GNUNET_SCHEDULER_NO_TASK;
 127   }
 128
 129   if (th != NULL)
 130     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
 131   th = NULL;
 132
 133   if (p1 != NULL)
 134     GNUNET_TRANSPORT_TESTING_stop_peer (tth, p1);
 135   if (p2 != NULL)
 136     GNUNET_TRANSPORT_TESTING_stop_peer (tth, p2);
 137
 138   ok = GNUNET_SYSERR;
 139 }
 140
 141 static void
 142 notify_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
 143 {
 144   struct PeerContext *p = cls;
 145   char *ps = GNUNET_strdup (GNUNET_i2s (&p->id));
 146
 147   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 148               "Peer %u (`%4s'): peer (`%s') disconnected from me!\n", p->no, ps,
 149               GNUNET_i2s (peer));
 150   GNUNET_free (ps);
 151
 152   if (th != NULL)
 153     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
 154   th = NULL;
 155
 156   if (shutdown_ == GNUNET_YES)
 157   {
 158     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Complete, shutting down...\n");
 159     GNUNET_SCHEDULER_add_now (&end, NULL);
 160   }
 161 }
 162
 163
 164 static void
 165 stop_peer (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 166 {
 167   if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
 168     return;
 169
 170   struct PeerContext *p = cls;
 171
 172   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Shutting down peer %u (`%s')\n", p->no,
 173               GNUNET_i2s (&p->id));
 174   shutdown_ = GNUNET_YES;
 175   GNUNET_TRANSPORT_TESTING_stop_peer (tth, p2);
 176   p2 = NULL;
 177   GNUNET_assert (p2 == NULL);
 178 }
 179
 180
 181 static void
 182 notify_receive (void *cls, const struct GNUNET_PeerIdentity *peer,
 183                 const struct GNUNET_MessageHeader *message)
 184 {
 185   struct PeerContext *p = cls;
 186   struct PeerContext *t = NULL;
 187
 188   if (0 == memcmp (peer, &p1->id, sizeof (struct GNUNET_PeerIdentity)))
 189     t = p1;
 190   if (0 == memcmp (peer, &p2->id, sizeof (struct GNUNET_PeerIdentity)))
 191     t = p2;
 192   GNUNET_assert (t != NULL);
 193
 194   char *ps = GNUNET_strdup (GNUNET_i2s (&p->id));
 195
 196   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 197               "Peer %u (`%4s') received message of type %d and size %u size from peer %u (`%4s')!\n",
 198               p->no, ps, ntohs (message->type), ntohs (message->size), t->no,
 199               GNUNET_i2s (&t->id));
 200   GNUNET_free (ps);
 201
 202   if ((MTYPE == ntohs (message->type)) &&
 203       (sizeof (struct GNUNET_MessageHeader) == ntohs (message->size)))
 204   {
 205     ok = 1;
 206     GNUNET_SCHEDULER_add_now (stop_peer, p2);
 207     return;
 208   }
 209 }
 210
 211
 212 static size_t
 213 notify_ready (void *cls, size_t size, void *buf)
 214 {
 215   struct PeerContext *p = cls;
 216   struct GNUNET_MessageHeader *hdr;
 217
 218   th = NULL;
 219
 220   if (buf == NULL)
 221   {
 222     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 223                 "Timeout occurred while waiting for transmit_ready\n");
 224     if (GNUNET_SCHEDULER_NO_TASK != die_task)
 225       GNUNET_SCHEDULER_cancel (die_task);
 226     die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
 227     ok = 42;
 228     return 0;
 229   }
 230
 231   GNUNET_assert (size >= 256);
 232
 233   if (buf != NULL)
 234   {
 235     hdr = buf;
 236     hdr->size = htons (sizeof (struct GNUNET_MessageHeader));
 237     hdr->type = htons (MTYPE);
 238   }
 239   char *ps = GNUNET_strdup (GNUNET_i2s (&p2->id));
 240
 241   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 242               "Peer %u (`%4s') sending message with type %u and size %u bytes to peer %u (`%4s')\n",
 243               p2->no, ps, ntohs (hdr->type), ntohs (hdr->size), p->no,
 244               GNUNET_i2s (&p->id));
 245   GNUNET_free (ps);
 246   return sizeof (struct GNUNET_MessageHeader);
 247 }
 248
 249
 250 static void
 251 sendtask (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 252 {
 253   send_task = GNUNET_SCHEDULER_NO_TASK;
 254
 255   if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
 256     return;
 257   char *receiver_s = GNUNET_strdup (GNUNET_i2s (&p1->id));
 258
 259   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 260               "Sending message from peer %u (`%4s') -> peer %u (`%s') !\n",
 261               p2->no, GNUNET_i2s (&p2->id), p1->no, receiver_s);
 262   GNUNET_free (receiver_s);
 263
 264   th = GNUNET_TRANSPORT_notify_transmit_ready (p2->th, &p1->id, 256, 0,
 265                                                TIMEOUT_TRANSMIT, &notify_ready,
 266                                                p1);
 267 }
 268
 269
 270 static void
 271 notify_connect (void *cls, const struct GNUNET_PeerIdentity *peer)
 272 {
 273   static int c;
 274
 275   c++;
 276   struct PeerContext *p = cls;
 277   struct PeerContext *t = NULL;
 278
 279   if (0 == memcmp (peer, &p1->id, sizeof (struct GNUNET_PeerIdentity)))
 280     t = p1;
 281   if (0 == memcmp (peer, &p2->id, sizeof (struct GNUNET_PeerIdentity)))
 282     t = p2;
 283   GNUNET_assert (t != NULL);
 284
 285   char *ps = GNUNET_strdup (GNUNET_i2s (&p->id));
 286
 287   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 288               "Peer %u (`%4s'): peer %u (`%s') connected to me!\n", p->no, ps,
 289               t->no, GNUNET_i2s (peer));
 290   GNUNET_free (ps);
 291 }
 292
 293
 294 static void
 295 testing_connect_cb (struct PeerContext *p1, struct PeerContext *p2, void *cls)
 296 {
 297   cc = NULL;
 298   char *p1_c = GNUNET_strdup (GNUNET_i2s (&p1->id));
 299
 300   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peers connected: %u (%s) <-> %u (%s)\n",
 301               p1->no, p1_c, p2->no, GNUNET_i2s (&p2->id));
 302   GNUNET_free (p1_c);
 303
 304   send_task = GNUNET_SCHEDULER_add_now (&sendtask, NULL);
 305 }
 306
 307
 308 static void
 309 start_cb (struct PeerContext *p, void *cls)
 310 {
 311   static int started;
 312
 313   started++;
 314   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 315               "Peer %u (`%s') started\n", p->no,
 316               GNUNET_i2s (&p->id));
 317   if (started != 2)
 318     return;
 319   char *sender_c = GNUNET_strdup (GNUNET_i2s (&p1->id));
 320
 321   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 322               "Test tries to connect peer %u (`%s') -> peer %u (`%s')\n",
 323               p1->no, sender_c, p2->no, GNUNET_i2s (&p2->id));
 324   GNUNET_free (sender_c);
 325   cc = GNUNET_TRANSPORT_TESTING_connect_peers (tth, p1, p2, &testing_connect_cb,
 326                                                NULL);
 327
 328 }
 329
 330
 331 static void
 332 run (void *cls, char *const *args, const char *cfgfile,
 333      const struct GNUNET_CONFIGURATION_Handle *cfg)
 334 {
 335   die_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly, NULL);
 336
 337   p1 = GNUNET_TRANSPORT_TESTING_start_peer (tth, cfg_file_p1, 1,
 338                                             &notify_receive, &notify_connect,
 339                                             &notify_disconnect, &start_cb,
 340                                             NULL);
 341
 342   p2 = GNUNET_TRANSPORT_TESTING_start_peer (tth, cfg_file_p2, 2,
 343                                             &notify_receive, &notify_connect,
 344                                             &notify_disconnect, &start_cb,
 345                                             NULL);
 346
 347   if ((p1 == NULL) || (p2 == NULL))
 348   {
 349     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Fail! Could not start peers!\n");
 350     if (die_task != GNUNET_SCHEDULER_NO_TASK)
 351       GNUNET_SCHEDULER_cancel (die_task);
 352     die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
 353     return;
 354   }
 355 }
 356
 357
 358 static int
 359 check ()
 360 {
 361   static char *const argv[] = { "test-transport-api",
 362     "-c",
 363     "test_transport_api_data.conf",
 364     NULL
 365   };
 366   static struct GNUNET_GETOPT_CommandLineOption options[] = {
 367     GNUNET_GETOPT_OPTION_END
 368   };
 369
 370   send_task = GNUNET_SCHEDULER_NO_TASK;
 371
 372   ok = 1;
 373   GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1, argv, test_name,
 374                       "nohelp", options, &run, &ok);
 375
 376   return ok;
 377 }
 378
 379 int
 380 main (int argc, char *argv[])
 381 {
 382   int ret;
 383
 384   GNUNET_TRANSPORT_TESTING_get_test_name (argv[0], &test_name);
 385
 386   GNUNET_log_setup (test_name,
 387                     "WARNING",
 388                     NULL);
 389
 390   GNUNET_TRANSPORT_TESTING_get_test_source_name (__FILE__, &test_source);
 391   GNUNET_TRANSPORT_TESTING_get_test_plugin_name (argv[0], test_source,
 392                                                  &test_plugin);
 393
 394   tth = GNUNET_TRANSPORT_TESTING_init ();
 395
 396   GNUNET_TRANSPORT_TESTING_get_config_name (argv[0], &cfg_file_p1, 1);
 397   GNUNET_TRANSPORT_TESTING_get_config_name (argv[0], &cfg_file_p2, 2);
 398
 399   ret = check ();
 400
 401   GNUNET_free (cfg_file_p1);
 402   GNUNET_free (cfg_file_p2);
 403
 404   GNUNET_free (test_source);
 405   GNUNET_free (test_plugin);
 406   GNUNET_free (test_name);
 407
 408   GNUNET_TRANSPORT_TESTING_done (tth);
 409
 410   return ret;
 411 }
 412
 413 /* end of test_transport_api.c */