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,
 144                 uint32_t ats_count)
 145 {
 146   struct PeerContext * p = cls;
 147   struct PeerContext *t = NULL;
 148
 149   if (0 == memcmp (peer, &p1->id, sizeof (struct GNUNET_PeerIdentity)))
 150     t = p1;
 151   if (0 == memcmp (peer, &p2->id, sizeof (struct GNUNET_PeerIdentity)))
 152     t = p2;
 153   GNUNET_assert (t != NULL);
 154
 155   char * ps = strdup (GNUNET_i2s(&p->id));
 156
 157   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 158               "Peer %u (`%4s') received message of type %d and size %u size from peer %u (`%4s')!\n",
 159               p->no, ps, ntohs (message->type), ntohs (message->size), t->no, 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 = strdup (GNUNET_i2s(&p2->id));
 204   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 205               "Peer %u (`%4s') sending message with type %u and size %u bytes to peer %u (`%4s')\n",
 206               p2->no,
 207               ps,
 208               ntohs (hdr->type),
 209               ntohs (hdr->size), p->no, GNUNET_i2s (&p->id));
 210   GNUNET_free (ps);
 211   return sizeof (struct GNUNET_MessageHeader);
 212 }
 213
 214
 215 static void
 216 sendtask (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 217 {
 218   send_task = GNUNET_SCHEDULER_NO_TASK;
 219
 220   if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
 221     return;
 222   char * receiver_s = strdup(GNUNET_i2s (&p1->id));
 223   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 224               "Sending message from peer %u (`%4s') -> peer %u (`%s') !\n",
 225               p2->no,
 226               GNUNET_i2s (&p2->id), p1->no, receiver_s);
 227   GNUNET_free (receiver_s);
 228
 229   th = GNUNET_TRANSPORT_notify_transmit_ready (p2->th, &p1->id, 256, 0,
 230                                                TIMEOUT_TRANSMIT, &notify_ready,
 231                                                p1);
 232 }
 233
 234
 235 static void
 236 notify_connect (void *cls, const struct GNUNET_PeerIdentity *peer,
 237                 const struct GNUNET_ATS_Information *ats,
 238                 uint32_t ats_count)
 239 {
 240   static int c;
 241   c++;
 242   struct PeerContext *p = cls;
 243   struct PeerContext *t = NULL;
 244
 245   if (0 == memcmp (peer, &p1->id, sizeof (struct GNUNET_PeerIdentity)))
 246     t = p1;
 247   if (0 == memcmp (peer, &p2->id, sizeof (struct GNUNET_PeerIdentity)))
 248     t = p2;
 249   GNUNET_assert (t!=NULL);
 250
 251   char * ps = strdup (GNUNET_i2s(&p->id));
 252   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer %u (`%4s'): peer %u (`%s') connected to me!\n",
 253               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 = strdup (GNUNET_i2s(&p->id));
 264   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer %u (`%4s'): peer (`%s') disconnected from me!\n",
 265               p->no, ps, GNUNET_i2s (peer));
 266
 267   if (th != NULL)
 268     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
 269   th = NULL;
 270 }
 271
 272 static void
 273 testing_connect_cb (struct PeerContext *p1, struct PeerContext *p2, void *cls)
 274 {
 275   cc = NULL;
 276   char *p1_c = strdup (GNUNET_i2s (&p1->id));
 277
 278   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peers connected: %u (%s) <-> %u (%s)\n",
 279               p1->no, p1_c,
 280               p2->no, GNUNET_i2s (&p2->id));
 281   GNUNET_free (p1_c);
 282
 283   send_task = GNUNET_SCHEDULER_add_now (&sendtask, NULL);
 284 }
 285
 286
 287
 288 void start_cb (struct PeerContext * p,
 289                void *cls)
 290 {
 291   static int started;
 292   started++;
 293
 294   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer %u (`%s') started\n",
 295        p->no,
 296        GNUNET_i2s (&p->id));
 297
 298   if (started != 2)
 299     return;
 300
 301   char *sender_c = strdup (GNUNET_i2s (&p1->id));
 302   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Test tries to connect peer %u (`%s') -> peer %u (`%s')\n",
 303               p1->no, sender_c,
 304               p2->no, GNUNET_i2s (&p2->id));
 305
 306   cc = GNUNET_TRANSPORT_TESTING_connect_peers (tth, p1, p2, &testing_connect_cb,
 307                                                NULL);
 308
 309 }
 310
 311 static void
 312 run (void *cls, char *const *args, const char *cfgfile,
 313      const struct GNUNET_CONFIGURATION_Handle *cfg)
 314 {
 315   die_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly, NULL);
 316
 317   p1 = GNUNET_TRANSPORT_TESTING_start_peer (tth, cfg_file_p1, 1,
 318       &notify_receive,
 319       &notify_connect,
 320       &notify_disconnect,
 321       &start_cb,
 322       NULL);
 323
 324   p2 = GNUNET_TRANSPORT_TESTING_start_peer (tth, cfg_file_p2, 2,
 325                                             &notify_receive,
 326                                             &notify_connect,
 327                                             &notify_disconnect,
 328                                             &start_cb,
 329                                             NULL);
 330
 331   if ((p1 == NULL) || (p2 == NULL))
 332   {
 333     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Fail! Could not start peers!\n");
 334     if (die_task != GNUNET_SCHEDULER_NO_TASK)
 335       GNUNET_SCHEDULER_cancel (die_task);
 336     die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
 337     return;
 338   }
 339 }
 340
 341
 342 static int
 343 check ()
 344 {
 345   static char *const argv[] = { "test-transport-api",
 346     "-c",
 347     "test_transport_api_data.conf",
 348 #if VERBOSE
 349     "-L", "DEBUG",
 350 #endif
 351     NULL
 352   };
 353   static struct GNUNET_GETOPT_CommandLineOption options[] = {
 354     GNUNET_GETOPT_OPTION_END
 355   };
 356
 357 #if WRITECONFIG
 358   setTransportOptions ("test_transport_api_data.conf");
 359 #endif
 360   send_task = GNUNET_SCHEDULER_NO_TASK;
 361
 362   ok = 1;
 363   GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1, argv, test_name,
 364                       "nohelp", options, &run, &ok);
 365
 366   return ok;
 367 }
 368
 369 int
 370 main (int argc, char *argv[])
 371 {
 372   int ret;
 373   int nat_res;
 374
 375   tth = GNUNET_TRANSPORT_TESTING_init ();
 376
 377   GNUNET_TRANSPORT_TESTING_get_test_source_name (__FILE__, &test_source);
 378   GNUNET_TRANSPORT_TESTING_get_test_plugin_name (argv[0], test_source,
 379                                                  &test_plugin);
 380   GNUNET_TRANSPORT_TESTING_get_test_name (argv[0], &test_name);
 381
 382   GNUNET_log_setup (test_name,
 383 #if VERBOSE
 384                     "DEBUG",
 385 #else
 386                     "WARNING",
 387 #endif
 388                     NULL);
 389
 390   if ((strcmp (test_plugin, "tcp_nat") == 0) ||
 391       (strcmp (test_plugin, "udp_nat") == 0))
 392   {
 393     nat_res = GNUNET_OS_check_helper_binary ("gnunet-nat-server");
 394     if (GNUNET_NO == nat_res)
 395     {
 396       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Cannot run NAT test: `%s' %s \n",
 397                   "gnunet-nat-server", "SUID not set");
 398       return 0;
 399     }
 400     if (GNUNET_SYSERR == nat_res)
 401     {
 402       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Cannot run NAT test: `%s' %s \n",
 403                   "gnunet-nat-server", "file not found");
 404       return 0;
 405     }
 406   }
 407
 408   GNUNET_TRANSPORT_TESTING_get_config_name (argv[0], &cfg_file_p1, 1);
 409   GNUNET_TRANSPORT_TESTING_get_config_name (argv[0], &cfg_file_p2, 2);
 410
 411   ret = check ();
 412
 413   GNUNET_free (cfg_file_p1);
 414   GNUNET_free (cfg_file_p2);
 415
 416   GNUNET_free (test_source);
 417   GNUNET_free (test_plugin);
 418   GNUNET_free (test_name);
 419
 420   GNUNET_TRANSPORT_TESTING_done (tth);
 421
 422   return ret;
 423 }
 424
 425 /* end of test_transport_api.c */