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