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