2 This file is part of GNUnet.
3 (C) 2009 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file src/transport/gnunet-transport.c
23 * @brief Tool to help configure, measure and control the transport subsystem.
24 * @author Christian Grothoff
25 * @author Nathan Evans
27 * This utility can be used to test if a transport mechanism for
28 * GNUnet is properly configured.
32 #include "gnunet_util_lib.h"
33 #include "gnunet_resolver_service.h"
34 #include "gnunet_protocols.h"
35 #include "gnunet_transport_service.h"
36 #include "gnunet_nat_lib.h"
39 * How long do we wait for the NAT test to report success?
41 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
44 * Which peer should we connect to?
49 * Handle to transport service.
51 static struct GNUNET_TRANSPORT_Handle *handle;
56 static int benchmark_send;
61 static int benchmark_receive;
66 static int benchmark_receive;
71 static int iterate_connections;
76 static int test_configuration;
84 * Global return value (0 success).
89 * Number of bytes of traffic we received so far.
91 static unsigned long long traffic_received;
94 * Number of bytes of traffic we sent so far.
96 static unsigned long long traffic_sent;
99 * Starting time of transmitting/receiving data.
101 static struct GNUNET_TIME_Absolute start_time;
104 * Handle for current transmission request.
106 static struct GNUNET_TRANSPORT_TransmitHandle *th;
109 * Identity of the peer we transmit to / connect to.
110 * (equivalent to 'cpid' string).
112 static struct GNUNET_PeerIdentity pid;
115 * Task scheduled for cleanup / termination of the process.
117 static GNUNET_SCHEDULER_TaskIdentifier end;
120 * Selected level of verbosity.
122 static int verbosity;
125 * Resolver process handle.
127 struct GNUNET_OS_Process *resolver;
130 * Number of tasks running that still need the resolver.
132 static unsigned int resolver_users;
136 * Context for a plugin test.
142 * Handle to the active NAT test.
144 struct GNUNET_NAT_Test *tst;
147 * Task identifier for the timeout.
149 GNUNET_SCHEDULER_TaskIdentifier tsk;
152 * Name of plugin under test.
160 * Display the result of the test.
162 * @param tc test context
163 * @param result GNUNET_YES on success
166 display_test_result (struct TestContext *tc, int result)
168 if (GNUNET_YES != result)
170 fprintf (stderr, "Configuration for plugin `%s' did not work!\n", tc->name);
174 fprintf (stderr, "Configuration for plugin `%s' is working!\n", tc->name);
176 if (GNUNET_SCHEDULER_NO_TASK != tc->tsk)
178 GNUNET_SCHEDULER_cancel (tc->tsk);
179 tc->tsk = GNUNET_SCHEDULER_NO_TASK;
183 GNUNET_NAT_test_stop (tc->tst);
188 if ((0 == resolver_users) && (NULL != resolver))
190 GNUNET_break (0 == GNUNET_OS_process_kill (resolver, SIGTERM));
191 GNUNET_OS_process_close (resolver);
198 * Function called by NAT on success.
199 * Clean up and update GUI (with success).
201 * @param cls test context
202 * @param success currently always GNUNET_OK
205 result_callback (void *cls, int success)
207 struct TestContext *tc = cls;
209 display_test_result (tc, success);
214 * Function called if NAT failed to confirm success.
215 * Clean up and update GUI (with failure).
217 * @param cls test context
218 * @param tc scheduler callback
221 fail_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
223 struct TestContext *tstc = cls;
225 tstc->tsk = GNUNET_SCHEDULER_NO_TASK;
226 display_test_result (tstc, GNUNET_NO);
231 * Test our plugin's configuration (NAT traversal, etc.).
233 * @param cfg configuration to test
236 do_test_configuration (const struct GNUNET_CONFIGURATION_Handle *cfg)
240 unsigned long long bnd_port;
241 unsigned long long adv_port;
242 struct TestContext *tc;
245 GNUNET_CONFIGURATION_get_value_string (cfg, "transport", "plugins",
250 ("No transport plugins configured, peer will never communicate\n"));
254 for (tok = strtok (plugins, " "); tok != NULL; tok = strtok (NULL, " "))
256 char section[12 + strlen (tok)];
258 GNUNET_snprintf (section, sizeof (section), "transport-%s", tok);
260 GNUNET_CONFIGURATION_get_value_number (cfg, section, "PORT", &bnd_port))
263 _("No port configured for plugin `%s', cannot test it\n"), tok);
267 GNUNET_CONFIGURATION_get_value_number (cfg, section, "ADVERTISED_PORT",
270 if (NULL == resolver)
272 GNUNET_OS_start_process (NULL, NULL, "gnunet-service-resolver",
273 "gnunet-service-resolver", NULL);
275 GNUNET_RESOLVER_connect (cfg);
276 tc = GNUNET_malloc (sizeof (struct TestContext));
277 tc->name = GNUNET_strdup (tok);
279 GNUNET_NAT_test_start (cfg,
282 "udp")) ? GNUNET_NO : GNUNET_YES,
283 (uint16_t) bnd_port, (uint16_t) adv_port,
284 &result_callback, tc);
287 display_test_result (tc, GNUNET_SYSERR);
290 tc->tsk = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &fail_timeout, tc);
292 GNUNET_free (plugins);
297 * Shutdown, print statistics.
300 do_disconnect (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
302 struct GNUNET_TIME_Relative duration;
306 GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
309 GNUNET_TRANSPORT_disconnect (handle);
310 if (benchmark_receive)
312 duration = GNUNET_TIME_absolute_get_duration (start_time);
313 fprintf (stdout, _("Received %llu bytes/s (%llu bytes in %llu ms)\n"),
314 1000 * traffic_received / (1 + duration.rel_value),
315 traffic_received, (unsigned long long) duration.rel_value);
319 duration = GNUNET_TIME_absolute_get_duration (start_time);
320 fprintf (stdout, _("Transmitted %llu bytes/s (%llu bytes in %llu ms)\n"),
321 1000 * traffic_sent / (1 + duration.rel_value), traffic_sent,
322 (unsigned long long) duration.rel_value);
328 * Function called to notify a client about the socket
329 * begin ready to queue more data. "buf" will be
330 * NULL and "size" zero if the socket was closed for
331 * writing in the meantime.
334 * @param size number of bytes available in buf
335 * @param buf where the callee should write the message
336 * @return number of bytes written to buf
339 transmit_data (void *cls, size_t size, void *buf)
341 struct GNUNET_MessageHeader *m = buf;
343 GNUNET_assert (size >= sizeof (struct GNUNET_MessageHeader));
344 GNUNET_assert (size < GNUNET_SERVER_MAX_MESSAGE_SIZE);
345 m->size = ntohs (size);
346 m->type = ntohs (GNUNET_MESSAGE_TYPE_DUMMY);
347 memset (&m[1], 52, size - sizeof (struct GNUNET_MessageHeader));
348 traffic_sent += size;
349 th = GNUNET_TRANSPORT_notify_transmit_ready (handle, &pid, 32 * 1024, 0,
350 GNUNET_TIME_UNIT_FOREVER_REL,
351 &transmit_data, NULL);
353 fprintf (stdout, _("Transmitting %u bytes to %s\n"), (unsigned int) size,
360 * Function called to notify transport users that another
361 * peer connected to us.
364 * @param peer the peer that connected
365 * @param ats performance data
366 * @param ats_count number of entries in ats (excluding 0-termination)
369 notify_connect (void *cls, const struct GNUNET_PeerIdentity *peer,
370 const struct GNUNET_ATS_Information *ats, uint32_t ats_count)
373 fprintf (stdout, _("Connected to %s\n"), GNUNET_i2s (peer));
374 if (0 != memcmp (&pid, peer, sizeof (struct GNUNET_PeerIdentity)))
379 start_time = GNUNET_TIME_absolute_get ();
380 th = GNUNET_TRANSPORT_notify_transmit_ready (handle, peer, 32 * 1024, 0,
381 GNUNET_TIME_UNIT_FOREVER_REL,
382 &transmit_data, NULL);
386 /* all done, terminate instantly */
387 GNUNET_SCHEDULER_cancel (end);
388 end = GNUNET_SCHEDULER_add_now (&do_disconnect, NULL);
394 * Function called to notify transport users that another
395 * peer disconnected from us.
398 * @param peer the peer that disconnected
401 notify_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
404 fprintf (stdout, _("Disconnected from %s\n"), GNUNET_i2s (peer));
405 if ((0 == memcmp (&pid, peer, sizeof (struct GNUNET_PeerIdentity))) &&
408 GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
410 GNUNET_SCHEDULER_cancel (end);
411 end = GNUNET_SCHEDULER_add_now (&do_disconnect, NULL);
417 * Function called by the transport for each received message.
420 * @param peer (claimed) identity of the other peer
421 * @param message the message
422 * @param ats performance data
423 * @param ats_count number of entries in ats
426 notify_receive (void *cls, const struct GNUNET_PeerIdentity *peer,
427 const struct GNUNET_MessageHeader *message,
428 const struct GNUNET_ATS_Information *ats, uint32_t ats_count)
430 if (!benchmark_receive)
433 fprintf (stdout, _("Received %u bytes from %s\n"),
434 (unsigned int) ntohs (message->size), GNUNET_i2s (peer));
435 if (traffic_received == 0)
436 start_time = GNUNET_TIME_absolute_get ();
437 traffic_received += ntohs (message->size);
440 void process_string (void *cls,
443 struct GNUNET_PeerIdentity * peer = cls;
445 if ((address != NULL))
447 fprintf (stdout, _("Peer `%s' : %s\n"), GNUNET_i2s(peer), address);
457 * Function to call with a human-readable format of an address
460 * @param peer identity of the peer
461 * @param transport name of the plugin
462 * @param addr binary address
463 * @param addrlen number of bytes in addr
466 process_address (void *cls, const struct GNUNET_HELLO_Address *address)
468 const struct GNUNET_CONFIGURATION_Handle * cfg = cls;
476 struct GNUNET_PeerIdentity * peer = GNUNET_malloc(sizeof (struct GNUNET_PeerIdentity));
477 *peer = address->peer;
479 /* Resolve address to string */
480 GNUNET_TRANSPORT_address_to_string (cfg,
483 GNUNET_TIME_UNIT_MINUTES,
490 * Main function that will be run by the scheduler.
493 * @param args remaining command-line arguments
494 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
495 * @param cfg configuration
498 run (void *cls, char *const *args, const char *cfgfile,
499 const struct GNUNET_CONFIGURATION_Handle *cfg)
501 if (test_configuration)
503 do_test_configuration (cfg);
505 if (benchmark_send && (NULL == cpid))
507 fprintf (stderr, _("Option `%s' makes no sense without option `%s'.\n"),
514 if (GNUNET_OK != GNUNET_CRYPTO_hash_from_string (cpid, &pid.hashPubKey))
516 fprintf (stderr, _("Failed to parse peer identity `%s'\n"), cpid);
520 GNUNET_TRANSPORT_connect (cfg, NULL, NULL, ¬ify_receive,
521 ¬ify_connect, ¬ify_disconnect);
522 GNUNET_TRANSPORT_try_connect (handle, &pid);
524 GNUNET_SCHEDULER_add_delayed (benchmark_send ?
525 GNUNET_TIME_UNIT_FOREVER_REL :
526 GNUNET_TIME_UNIT_SECONDS, &do_disconnect,
529 else if (benchmark_receive)
532 GNUNET_TRANSPORT_connect (cfg, NULL, NULL, ¬ify_receive,
533 ¬ify_connect, ¬ify_disconnect);
534 GNUNET_TRANSPORT_try_connect (handle, &pid);
536 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
537 &do_disconnect, NULL);
539 if (iterate_connections)
541 GNUNET_TRANSPORT_address_iterate (cfg, GNUNET_TIME_UNIT_MINUTES,
542 &process_address, (void *)cfg);
548 main (int argc, char *const *argv)
550 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
551 {'b', "benchmark", NULL,
552 gettext_noop ("measure how fast we are receiving data (until CTRL-C)"),
553 0, &GNUNET_GETOPT_set_one, &benchmark_receive},
554 {'C', "connect", "PEER",
555 gettext_noop ("try to connect to the given peer"),
556 1, &GNUNET_GETOPT_set_string, &cpid},
557 {'i', "information", NULL,
558 gettext_noop ("provide information about all current connections (once)"),
559 0, &GNUNET_GETOPT_set_one, &iterate_connections},
562 ("send data for benchmarking to the other peer (until CTRL-C)"),
563 0, &GNUNET_GETOPT_set_one, &benchmark_send},
565 gettext_noop ("test transport configuration (involves external server)"),
566 0, &GNUNET_GETOPT_set_one, &test_configuration},
567 {'n', "numeric", NULL,
568 gettext_noop ("do not resolve hostnames"),
569 0, &GNUNET_GETOPT_set_one, &numeric},
570 GNUNET_GETOPT_OPTION_VERBOSE (&verbosity),
571 GNUNET_GETOPT_OPTION_END
574 GNUNET_PROGRAM_run (argc, argv, "gnunet-transport",
576 ("Direct access to transport service."), options,
577 &run, NULL)) ? ret : 1;
581 /* end of gnunet-transport.c */