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_NO
  41
  42 #define VERBOSE_ARM GNUNET_NO
  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     GNUNET_TRANSPORT_TESTING_connect_peers_cancel (cc);
 120
 121   if (th != NULL)
 122     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
 123   th = NULL;
 124
 125   if (p1 != NULL)
 126     GNUNET_TRANSPORT_TESTING_stop_peer (p1);
 127   if (p2 != NULL)
 128     GNUNET_TRANSPORT_TESTING_stop_peer (p2);
 129
 130   ok = GNUNET_SYSERR;
 131 }
 132
 133
 134 static void
 135 notify_receive (void *cls, const struct GNUNET_PeerIdentity *peer,
 136                 const struct GNUNET_MessageHeader *message,
 137                 const struct GNUNET_TRANSPORT_ATS_Information *ats,
 138                 uint32_t ats_count)
 139 {
 140   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 141               "Received message of type %d from peer %s!\n",
 142               ntohs (message->type), GNUNET_i2s (peer));
 143
 144   if ((MTYPE == ntohs (message->type)) &&
 145       (sizeof (struct GNUNET_MessageHeader) == ntohs (message->size)))
 146   {
 147     ok = 0;
 148     end ();
 149   }
 150   else
 151   {
 152     GNUNET_break (0);
 153     ok = 1;
 154     end ();
 155   }
 156 }
 157
 158
 159 static size_t
 160 notify_ready (void *cls, size_t size, void *buf)
 161 {
 162   struct PeerContext *p = cls;
 163   struct GNUNET_MessageHeader *hdr;
 164
 165   th = NULL;
 166
 167   if (buf == NULL)
 168   {
 169     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 170                 "Timeout occurred while waiting for transmit_ready\n");
 171     if (GNUNET_SCHEDULER_NO_TASK != die_task)
 172       GNUNET_SCHEDULER_cancel (die_task);
 173     die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
 174     ok = 42;
 175     return 0;
 176   }
 177
 178   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 179               "Transmitting message with %u bytes to peer %s\n",
 180               sizeof (struct GNUNET_MessageHeader), GNUNET_i2s (&p->id));
 181   GNUNET_assert (size >= 256);
 182
 183   if (buf != NULL)
 184   {
 185     hdr = buf;
 186     hdr->size = htons (sizeof (struct GNUNET_MessageHeader));
 187     hdr->type = htons (MTYPE);
 188   }
 189   return sizeof (struct GNUNET_MessageHeader);
 190 }
 191
 192
 193 static void
 194 notify_connect (void *cls, const struct GNUNET_PeerIdentity *peer,
 195                 const struct GNUNET_TRANSPORT_ATS_Information *ats,
 196                 uint32_t ats_count)
 197 {
 198   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer `%4s' connected to us (%p)!\n",
 199               GNUNET_i2s (peer), cls);
 200 }
 201
 202
 203 static void
 204 notify_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
 205 {
 206   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer `%4s' disconnected (%p)!\n",
 207               GNUNET_i2s (peer), cls);
 208 }
 209
 210 static void
 211 sendtask (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 212 {
 213   send_task = GNUNET_SCHEDULER_NO_TASK;
 214
 215   if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
 216     return;
 217
 218   th = GNUNET_TRANSPORT_notify_transmit_ready (p1->th, &p2->id, 256, 0,
 219                                                TIMEOUT_TRANSMIT, &notify_ready,
 220                                                &p1);
 221 }
 222
 223 static void
 224 testing_connect_cb (struct PeerContext *p1, struct PeerContext *p2, void *cls)
 225 {
 226   cc = NULL;
 227   char *p1_c = strdup (GNUNET_i2s (&p1->id));
 228
 229   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peers connected: %s <-> %s\n", p1_c,
 230               GNUNET_i2s (&p2->id));
 231   GNUNET_free (p1_c);
 232
 233   // FIXME: THIS IS REQUIRED! SEEMS TO BE A BUG!
 234   send_task =
 235       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS, &sendtask, NULL);
 236 }
 237
 238 static void
 239 run (void *cls, char *const *args, const char *cfgfile,
 240      const struct GNUNET_CONFIGURATION_Handle *cfg)
 241 {
 242   die_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly, NULL);
 243
 244   p1 = GNUNET_TRANSPORT_TESTING_start_peer (cfg_file_p1, &notify_receive,
 245                                             &notify_connect, &notify_disconnect,
 246                                             NULL);
 247   p2 = GNUNET_TRANSPORT_TESTING_start_peer (cfg_file_p2, &notify_receive,
 248                                             &notify_connect, &notify_disconnect,
 249                                             NULL);
 250
 251   if ((p1 == NULL) || (p2 == NULL))
 252   {
 253     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Fail! Could not start peers!\n");
 254     if (die_task != GNUNET_SCHEDULER_NO_TASK)
 255       GNUNET_SCHEDULER_cancel (die_task);
 256     die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
 257     return;
 258   }
 259
 260   cc = GNUNET_TRANSPORT_TESTING_connect_peers (p1, p2, &testing_connect_cb,
 261                                                NULL);
 262 }
 263
 264
 265 static int
 266 check ()
 267 {
 268   static char *const argv[] = { "test-transport-api",
 269     "-c",
 270     "test_transport_api_data.conf",
 271 #if VERBOSE
 272     "-L", "DEBUG",
 273 #endif
 274     NULL
 275   };
 276   static struct GNUNET_GETOPT_CommandLineOption options[] = {
 277     GNUNET_GETOPT_OPTION_END
 278   };
 279
 280 #if WRITECONFIG
 281   setTransportOptions ("test_transport_api_data.conf");
 282 #endif
 283   send_task = GNUNET_SCHEDULER_NO_TASK;
 284
 285   ok = 1;
 286   GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1, argv, test_name,
 287                       "nohelp", options, &run, &ok);
 288
 289   return ok;
 290 }
 291
 292 int
 293 main (int argc, char *argv[])
 294 {
 295   int ret;
 296   int nat_res;
 297
 298   GNUNET_TRANSPORT_TESTING_get_test_source_name (__FILE__, &test_source);
 299   GNUNET_TRANSPORT_TESTING_get_test_plugin_name (argv[0], test_source,
 300                                                  &test_plugin);
 301   GNUNET_TRANSPORT_TESTING_get_test_name (argv[0], &test_name);
 302
 303   GNUNET_log_setup (test_name,
 304 #if VERBOSE
 305                     "DEBUG",
 306 #else
 307                     "WARNING",
 308 #endif
 309                     NULL);
 310
 311   if ((strcmp (test_plugin, "tcp_nat") == 0) ||
 312       (strcmp (test_plugin, "udp_nat") == 0))
 313   {
 314     nat_res = GNUNET_OS_check_helper_binary ("gnunet-nat-server");
 315     if (GNUNET_NO == nat_res)
 316     {
 317       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Cannot run NAT test: `%s' %s \n",
 318                   "gnunet-nat-server", "SUID not set");
 319       return 0;
 320     }
 321     if (GNUNET_SYSERR == nat_res)
 322     {
 323       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Cannot run NAT test: `%s' %s \n",
 324                   "gnunet-nat-server", "file not found");
 325       return 0;
 326     }
 327   }
 328
 329   GNUNET_TRANSPORT_TESTING_get_config_name (argv[0], &cfg_file_p1, 1);
 330   GNUNET_TRANSPORT_TESTING_get_config_name (argv[0], &cfg_file_p2, 2);
 331
 332   ret = check ();
 333
 334   GNUNET_free (cfg_file_p1);
 335   GNUNET_free (cfg_file_p2);
 336
 337   GNUNET_free (test_source);
 338   GNUNET_free (test_plugin);
 339   GNUNET_free (test_name);
 340
 341
 342   return ret;
 343 }
 344
 345 /* end of test_transport_api.c */