src/transport/test_transport_api.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009 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 2, 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
  39 #define VERBOSE GNUNET_YES
  40
  41 #define VERBOSE_ARM GNUNET_NO
  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, 50)
  49
  50 #define MTYPE 12345
  51
  52 struct PeerContext
  53 {
  54   struct GNUNET_CONFIGURATION_Handle *cfg;
  55   struct GNUNET_TRANSPORT_Handle *th;
  56   struct GNUNET_PeerIdentity id;
  57 #if START_ARM
  58   pid_t arm_pid;
  59 #endif
  60 };
  61
  62 static struct PeerContext p1;
  63
  64 static struct PeerContext p2;
  65
  66 static struct GNUNET_SCHEDULER_Handle *sched;
  67
  68 static int ok;
  69
  70 static int is_tcp;
  71
  72 static int is_tcp_nat;
  73
  74 static int is_udp;
  75
  76 static int is_udp_nat;
  77
  78 static int is_http;
  79
  80 static  GNUNET_SCHEDULER_TaskIdentifier die_task;
  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   /* do work here */
  93   GNUNET_assert (ok == 6);
  94   GNUNET_SCHEDULER_cancel (sched, die_task);
  95   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Disconnecting from transports!\n");
  96   GNUNET_TRANSPORT_disconnect (p1.th);
  97   GNUNET_TRANSPORT_disconnect (p2.th);
  98
  99   die_task = GNUNET_SCHEDULER_NO_TASK;
 100   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transports disconnected, returning success!\n");
 101   ok = 0;
 102 }
 103
 104 static void
 105 stop_arm (struct PeerContext *p)
 106 {
 107 #if START_ARM
 108   if (0 != PLIBC_KILL (p->arm_pid, SIGTERM))
 109     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
 110   GNUNET_OS_process_wait (p->arm_pid);
 111 #endif
 112   GNUNET_CONFIGURATION_destroy (p->cfg);
 113 }
 114
 115
 116 static void
 117 end_badly ()
 118 {
 119   GNUNET_break (0);
 120   GNUNET_TRANSPORT_disconnect (p1.th);
 121   GNUNET_TRANSPORT_disconnect (p2.th);
 122   ok = 1;
 123 }
 124
 125 static void
 126 notify_receive (void *cls,
 127                 const struct GNUNET_PeerIdentity *peer,
 128                 const struct GNUNET_MessageHeader *message,
 129                 struct GNUNET_TIME_Relative latency,
 130                 uint32_t distance)
 131 {
 132   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ok is (%d)!\n",
 133               ok);
 134
 135   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received message of type %d from peer (%p)!\n",
 136                 ntohs(message->type), cls);
 137
 138   GNUNET_assert (ok == 5);
 139   OKPP;
 140
 141   GNUNET_assert (MTYPE == ntohs (message->type));
 142   GNUNET_assert (sizeof (struct GNUNET_MessageHeader) ==
 143                  ntohs (message->size));
 144   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received message from peer (%p)!\n",
 145               cls);
 146   end ();
 147 }
 148
 149
 150 static size_t
 151 notify_ready (void *cls, size_t size, void *buf)
 152 {
 153   struct GNUNET_MessageHeader *hdr;
 154
 155   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 156               "Transmitting message to peer (%p) - %u!\n", cls, size);
 157   GNUNET_assert (size >= 256);
 158   GNUNET_assert (ok == 4);
 159   OKPP;
 160   if (buf != NULL)
 161   {
 162     hdr = buf;
 163     hdr->size = htons (sizeof (struct GNUNET_MessageHeader));
 164     hdr->type = htons (MTYPE);
 165   }
 166
 167   return sizeof (struct GNUNET_MessageHeader);
 168 }
 169
 170
 171 static void
 172 notify_connect (void *cls,
 173                 const struct GNUNET_PeerIdentity *peer,
 174                 struct GNUNET_TIME_Relative latency,
 175                 uint32_t distance)
 176 {
 177   if (cls == &p1)
 178     {
 179       GNUNET_TRANSPORT_notify_transmit_ready (p1.th,
 180                                               &p2.id,
 181                                               256, 0, TIMEOUT, &notify_ready,
 182                                               &p1);
 183     }
 184   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 185               "Peer `%4s' connected to us (%p)!\n", GNUNET_i2s (peer), cls);
 186 }
 187
 188
 189 static void
 190 notify_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
 191 {
 192   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 193               "Peer `%4s' disconnected (%p)!\n",
 194               GNUNET_i2s (peer), cls);
 195 }
 196
 197
 198 static void
 199 setup_peer (struct PeerContext *p, const char *cfgname)
 200 {
 201   p->cfg = GNUNET_CONFIGURATION_create ();
 202 #if START_ARM
 203   p->arm_pid = GNUNET_OS_start_process (NULL, NULL, "gnunet-service-arm",
 204                                         "gnunet-service-arm",
 205 #if VERBOSE_ARM
 206                                         "-L", "DEBUG",
 207 #endif
 208                                         "-c", cfgname, NULL);
 209 #endif
 210   GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_load (p->cfg, cfgname));
 211
 212   p->th = GNUNET_TRANSPORT_connect (sched, p->cfg,
 213                                     p,
 214                                     &notify_receive,
 215                                     &notify_connect, &notify_disconnect);
 216   GNUNET_assert (p->th != NULL);
 217 }
 218
 219
 220 static void
 221 exchange_hello_last (void *cls,
 222                      const struct GNUNET_MessageHeader *message)
 223 {
 224   struct PeerContext *me = cls;
 225
 226   GNUNET_TRANSPORT_get_hello_cancel (p2.th, &exchange_hello_last, me);
 227   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 228               "Exchanging HELLO with peer (%p)!\n", cls);
 229   GNUNET_assert (ok >= 3);
 230   OKPP;
 231   GNUNET_assert (message != NULL);
 232   GNUNET_assert (GNUNET_OK ==
 233                  GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *)
 234                                       message, &me->id));
 235   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 236               "Finished exchanging HELLOs, now waiting for transmission!\n");
 237 }
 238
 239 static void
 240 exchange_hello (void *cls,
 241                 const struct GNUNET_MessageHeader *message)
 242 {
 243   struct PeerContext *me = cls;
 244
 245   GNUNET_TRANSPORT_get_hello_cancel (p1.th, &exchange_hello, me);
 246   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 247               "Exchanging HELLO with peer (%p)!\n", cls);
 248   GNUNET_assert (ok >= 2);
 249   OKPP;
 250   GNUNET_assert (message != NULL);
 251   GNUNET_assert (GNUNET_OK ==
 252                  GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *)
 253                                       message, &me->id));
 254
 255   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 256               "Received HELLO size %d\n", GNUNET_HELLO_size((const struct GNUNET_HELLO_Message *)message));
 257
 258   GNUNET_TRANSPORT_offer_hello (p2.th, message);
 259   GNUNET_TRANSPORT_get_hello (p2.th, &exchange_hello_last, &p2);
 260 }
 261
 262 static void
 263 run (void *cls,
 264      struct GNUNET_SCHEDULER_Handle *s,
 265      char *const *args,
 266      const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *cfg)
 267 {
 268   GNUNET_assert (ok == 1);
 269   OKPP;
 270   sched = s;
 271
 272   die_task = GNUNET_SCHEDULER_add_delayed (sched,
 273       GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MINUTES, 1), &end_badly, NULL);
 274
 275   if (is_udp)
 276     {
 277       setup_peer (&p1, "test_transport_api_udp_peer1.conf");
 278       setup_peer (&p2, "test_transport_api_udp_peer2.conf");
 279     }
 280   else if (is_tcp)
 281     {
 282       setup_peer (&p1, "test_transport_api_tcp_peer1.conf");
 283       setup_peer (&p2, "test_transport_api_tcp_peer2.conf");
 284     }
 285   else if (is_tcp_nat)
 286     {
 287       setup_peer (&p1, "test_transport_api_tcp_nat_peer1.conf");
 288       setup_peer (&p2, "test_transport_api_tcp_nat_peer2.conf");
 289     }
 290   else if (is_udp_nat)
 291     {
 292       setup_peer (&p1, "test_transport_api_udp_nat_peer1.conf");
 293       setup_peer (&p2, "test_transport_api_udp_nat_peer2.conf");
 294     }
 295   else if (is_http)
 296     {
 297       setup_peer (&p1, "test_transport_api_http_peer1.conf");
 298       setup_peer (&p2, "test_transport_api_http_peer2.conf");
 299     }
 300
 301   GNUNET_assert(p1.th != NULL);
 302   GNUNET_assert(p2.th != NULL);
 303
 304   GNUNET_TRANSPORT_get_hello (p1.th, &exchange_hello, &p1);
 305 }
 306
 307 static int
 308 check ()
 309 {
 310
 311   char *const argv[] = { "test-transport-api",
 312     "-c",
 313     "test_transport_api_data.conf",
 314 #if VERBOSE
 315     "-L", "DEBUG",
 316 #endif
 317     NULL
 318   };
 319
 320 #if WRITECONFIG
 321   setTransportOptions("test_transport_api_data.conf");
 322 #endif
 323
 324   struct GNUNET_GETOPT_CommandLineOption options[] = {
 325     GNUNET_GETOPT_OPTION_END
 326   };
 327
 328   ok = 1;
 329   GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1,
 330                       argv, "test-transport-api", "nohelp",
 331                       options, &run, &ok);
 332   stop_arm (&p1);
 333   stop_arm (&p2);
 334   return ok;
 335 }
 336
 337
 338 static char *
 339 get_path_from_PATH ()
 340 {
 341   char *path;
 342   char *pos;
 343   char *end;
 344   char *buf;
 345   const char *p;
 346
 347   p = getenv ("PATH");
 348   if (p == NULL)
 349     return NULL;
 350   path = GNUNET_strdup (p);     /* because we write on it */
 351   buf = GNUNET_malloc (strlen (path) + 20);
 352   pos = path;
 353
 354   while (NULL != (end = strchr (pos, ':')))
 355     {
 356       *end = '\0';
 357       sprintf (buf, "%s/%s", pos, "gnunet-nat-server");
 358       if (GNUNET_DISK_file_test (buf) == GNUNET_YES)
 359         {
 360           GNUNET_free (path);
 361           return buf;
 362         }
 363       pos = end + 1;
 364     }
 365   sprintf (buf, "%s/%s", pos, "gnunet-nat-server");
 366   if (GNUNET_DISK_file_test (buf) == GNUNET_YES)
 367     {
 368       GNUNET_free (path);
 369       return buf;
 370     }
 371   GNUNET_free (buf);
 372   GNUNET_free (path);
 373   return NULL;
 374 }
 375
 376
 377 static int
 378 check_gnunet_nat_server()
 379 {
 380   struct stat statbuf;
 381   char *p;
 382
 383   p = get_path_from_PATH ();
 384   if (p == NULL)
 385     return GNUNET_NO;
 386   if (0 != STAT (p, &statbuf))
 387     {
 388       GNUNET_free (p);
 389       return GNUNET_SYSERR;
 390     }
 391   GNUNET_free (p);
 392   if ( (0 != (statbuf.st_mode & S_ISUID)) &&
 393        (statbuf.st_uid == 0) )
 394     return GNUNET_YES;
 395   return GNUNET_NO;
 396 }
 397
 398 int
 399 main (int argc, char *argv[])
 400 {
 401   int ret;
 402 #ifdef MINGW
 403   return GNUNET_SYSERR;
 404 #endif
 405   if (strstr(argv[0], "tcp_nat") != NULL)
 406     {
 407       is_tcp_nat = GNUNET_YES;
 408       if (check_gnunet_nat_server() != GNUNET_OK)
 409         {
 410           GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 411                       "`%s' not properly installed, cannot run NAT test!\n",
 412                       "gnunet-nat-server");
 413           return 0;
 414         }
 415     }
 416   else if (strstr(argv[0], "tcp") != NULL)
 417     {
 418       is_tcp = GNUNET_YES;
 419     }
 420   else if (strstr(argv[0], "udp_nat") != NULL)
 421     {
 422       is_udp_nat = GNUNET_YES;
 423       if (check_gnunet_nat_server() != GNUNET_OK)
 424         {
 425           GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 426                       "`%s' not properly installed, cannot run NAT test!\n",
 427                       "gnunet-nat-server");
 428           return 0;
 429         }
 430     }
 431   else if (strstr(argv[0], "udp") != NULL)
 432     {
 433       is_udp = GNUNET_YES;
 434     }
 435   else if (strstr(argv[0], "http") != NULL)
 436     {
 437       is_http = GNUNET_YES;
 438     }
 439
 440   GNUNET_log_setup ("test-transport-api",
 441 #if VERBOSE
 442                     "DEBUG",
 443 #else
 444                     "WARNING",
 445 #endif
 446                     NULL);
 447   ret = check ();
 448   GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-transport-peer-1");
 449   GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-transport-peer-2");
 450   return ret;
 451 }
 452
 453 /* end of test_transport_api.c */