2 This file is part of GNUnet.
3 (C) 2011 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;
81 static int monitor_connections;
89 * Global return value (0 success).
94 * Number of bytes of traffic we received so far.
96 static unsigned long long traffic_received;
99 * Number of bytes of traffic we sent so far.
101 static unsigned long long traffic_sent;
104 * Starting time of transmitting/receiving data.
106 static struct GNUNET_TIME_Absolute start_time;
109 * Handle for current transmission request.
111 static struct GNUNET_TRANSPORT_TransmitHandle *th;
114 * Identity of the peer we transmit to / connect to.
115 * (equivalent to 'cpid' string).
117 static struct GNUNET_PeerIdentity pid;
120 * Task scheduled for cleanup / termination of the process.
122 static GNUNET_SCHEDULER_TaskIdentifier end;
125 * Selected level of verbosity.
127 static int verbosity;
130 * Resolver process handle.
132 struct GNUNET_OS_Process *resolver;
135 * Number of tasks running that still need the resolver.
137 static unsigned int resolver_users;
141 * Context for a plugin test.
147 * Handle to the active NAT test.
149 struct GNUNET_NAT_Test *tst;
152 * Task identifier for the timeout.
154 GNUNET_SCHEDULER_TaskIdentifier tsk;
157 * Name of plugin under test.
165 * Display the result of the test.
167 * @param tc test context
168 * @param result GNUNET_YES on success
171 display_test_result (struct TestContext *tc, int result)
173 if (GNUNET_YES != result)
175 FPRINTF (stderr, "Configuration for plugin `%s' did not work!\n", tc->name);
179 FPRINTF (stderr, "Configuration for plugin `%s' is working!\n", tc->name);
181 if (GNUNET_SCHEDULER_NO_TASK != tc->tsk)
183 GNUNET_SCHEDULER_cancel (tc->tsk);
184 tc->tsk = GNUNET_SCHEDULER_NO_TASK;
188 GNUNET_NAT_test_stop (tc->tst);
193 if ((0 == resolver_users) && (NULL != resolver))
195 GNUNET_break (0 == GNUNET_OS_process_kill (resolver, SIGTERM));
196 GNUNET_OS_process_close (resolver);
203 * Function called by NAT on success.
204 * Clean up and update GUI (with success).
206 * @param cls test context
207 * @param success currently always GNUNET_OK
210 result_callback (void *cls, int success)
212 struct TestContext *tc = cls;
214 display_test_result (tc, success);
219 * Function called if NAT failed to confirm success.
220 * Clean up and update GUI (with failure).
222 * @param cls test context
223 * @param tc scheduler callback
226 fail_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
228 struct TestContext *tstc = cls;
230 tstc->tsk = GNUNET_SCHEDULER_NO_TASK;
231 display_test_result (tstc, GNUNET_NO);
236 * Test our plugin's configuration (NAT traversal, etc.).
238 * @param cfg configuration to test
241 do_test_configuration (const struct GNUNET_CONFIGURATION_Handle *cfg)
245 unsigned long long bnd_port;
246 unsigned long long adv_port;
247 struct TestContext *tc;
250 GNUNET_CONFIGURATION_get_value_string (cfg, "transport", "plugins",
256 ("No transport plugins configured, peer will never communicate\n"));
260 for (tok = strtok (plugins, " "); tok != NULL; tok = strtok (NULL, " "))
262 char section[12 + strlen (tok)];
264 GNUNET_snprintf (section, sizeof (section), "transport-%s", tok);
266 GNUNET_CONFIGURATION_get_value_number (cfg, section, "PORT", &bnd_port))
269 _("No port configured for plugin `%s', cannot test it\n"), tok);
273 GNUNET_CONFIGURATION_get_value_number (cfg, section, "ADVERTISED_PORT",
276 if (NULL == resolver)
278 GNUNET_OS_start_process (NULL, NULL, "gnunet-service-resolver",
279 "gnunet-service-resolver", NULL);
281 GNUNET_RESOLVER_connect (cfg);
282 tc = GNUNET_malloc (sizeof (struct TestContext));
283 tc->name = GNUNET_strdup (tok);
285 GNUNET_NAT_test_start (cfg,
288 "udp")) ? GNUNET_NO : GNUNET_YES,
289 (uint16_t) bnd_port, (uint16_t) adv_port,
290 &result_callback, tc);
293 display_test_result (tc, GNUNET_SYSERR);
296 tc->tsk = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &fail_timeout, tc);
298 GNUNET_free (plugins);
303 * Shutdown, print statistics.
306 do_disconnect (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
308 struct GNUNET_TIME_Relative duration;
312 GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
315 GNUNET_TRANSPORT_disconnect (handle);
316 if (benchmark_receive)
318 duration = GNUNET_TIME_absolute_get_duration (start_time);
319 FPRINTF (stdout, _("Received %llu bytes/s (%llu bytes in %llu ms)\n"),
320 1000 * traffic_received / (1 + duration.rel_value),
321 traffic_received, (unsigned long long) duration.rel_value);
325 duration = GNUNET_TIME_absolute_get_duration (start_time);
326 FPRINTF (stdout, _("Transmitted %llu bytes/s (%llu bytes in %llu ms)\n"),
327 1000 * traffic_sent / (1 + duration.rel_value), traffic_sent,
328 (unsigned long long) duration.rel_value);
334 * Function called to notify a client about the socket
335 * begin ready to queue more data. "buf" will be
336 * NULL and "size" zero if the socket was closed for
337 * writing in the meantime.
340 * @param size number of bytes available in buf
341 * @param buf where the callee should write the message
342 * @return number of bytes written to buf
345 transmit_data (void *cls, size_t size, void *buf)
347 struct GNUNET_MessageHeader *m = buf;
349 GNUNET_assert (size >= sizeof (struct GNUNET_MessageHeader));
350 GNUNET_assert (size < GNUNET_SERVER_MAX_MESSAGE_SIZE);
351 m->size = ntohs (size);
352 m->type = ntohs (GNUNET_MESSAGE_TYPE_DUMMY);
353 memset (&m[1], 52, size - sizeof (struct GNUNET_MessageHeader));
354 traffic_sent += size;
355 th = GNUNET_TRANSPORT_notify_transmit_ready (handle, &pid, 32 * 1024, 0,
356 GNUNET_TIME_UNIT_FOREVER_REL,
357 &transmit_data, NULL);
359 FPRINTF (stdout, _("Transmitting %u bytes to %s\n"), (unsigned int) size,
366 * Function called to notify transport users that another
367 * peer connected to us.
370 * @param peer the peer that connected
371 * @param ats performance data
372 * @param ats_count number of entries in ats (excluding 0-termination)
375 notify_connect (void *cls, const struct GNUNET_PeerIdentity *peer,
376 const struct GNUNET_ATS_Information *ats, uint32_t ats_count)
379 FPRINTF (stdout, _("Connected to %s\n"), GNUNET_i2s (peer));
380 if (0 != memcmp (&pid, peer, sizeof (struct GNUNET_PeerIdentity)))
385 start_time = GNUNET_TIME_absolute_get ();
386 th = GNUNET_TRANSPORT_notify_transmit_ready (handle, peer, 32 * 1024, 0,
387 GNUNET_TIME_UNIT_FOREVER_REL,
388 &transmit_data, NULL);
392 /* all done, terminate instantly */
393 GNUNET_SCHEDULER_cancel (end);
394 end = GNUNET_SCHEDULER_add_now (&do_disconnect, NULL);
400 * Function called to notify transport users that another
401 * peer disconnected from us.
404 * @param peer the peer that disconnected
407 notify_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
410 FPRINTF (stdout, _("Disconnected from %s\n"), GNUNET_i2s (peer));
411 if ((0 == memcmp (&pid, peer, sizeof (struct GNUNET_PeerIdentity))) &&
414 GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
416 GNUNET_SCHEDULER_cancel (end);
417 end = GNUNET_SCHEDULER_add_now (&do_disconnect, NULL);
423 * Function called by the transport for each received message.
426 * @param peer (claimed) identity of the other peer
427 * @param message the message
428 * @param ats performance data
429 * @param ats_count number of entries in ats
432 notify_receive (void *cls, const struct GNUNET_PeerIdentity *peer,
433 const struct GNUNET_MessageHeader *message,
434 const struct GNUNET_ATS_Information *ats, uint32_t ats_count)
436 if (!benchmark_receive)
439 FPRINTF (stdout, _("Received %u bytes from %s\n"),
440 (unsigned int) ntohs (message->size), GNUNET_i2s (peer));
441 if (traffic_received == 0)
442 start_time = GNUNET_TIME_absolute_get ();
443 traffic_received += ntohs (message->size);
447 process_string (void *cls, const char *address)
449 struct GNUNET_HELLO_Address *addrcp = cls;
451 if ((address != NULL))
453 FPRINTF (stdout, _("Peer `%s': %s %s\n"), GNUNET_i2s (&addrcp->peer), addrcp->transport_name, address);
458 GNUNET_free (addrcp);
463 * Function to call with a binary address
466 * @param peer identity of the peer
467 * @param address binary address (NULL on disconnect)
470 process_address (void *cls, const struct GNUNET_PeerIdentity *peer,
471 const struct GNUNET_HELLO_Address *address)
473 const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
483 FPRINTF (stdout, _("Peer `%s' disconnected\n"), GNUNET_i2s (peer));
487 /* Resolve address to string */
488 GNUNET_TRANSPORT_address_to_string (cfg, address, numeric,
489 GNUNET_TIME_UNIT_MINUTES, &process_string,
490 GNUNET_HELLO_address_copy(address));
495 * Task run in monitor mode when the user presses CTRL-C to abort.
496 * Stops monitoring activity.
498 * @param cls the 'struct GNUNET_TRANSPORT_PeerIterateContext *'
499 * @param tc scheduler context
502 shutdown_task (void *cls,
503 const struct GNUNET_SCHEDULER_TaskContext *tc)
505 struct GNUNET_TRANSPORT_PeerIterateContext *pic = cls;
507 GNUNET_TRANSPORT_peer_get_active_addresses_cancel (pic);
513 * Main function that will be run by the scheduler.
516 * @param args remaining command-line arguments
517 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
518 * @param cfg configuration
521 run (void *cls, char *const *args, const char *cfgfile,
522 const struct GNUNET_CONFIGURATION_Handle *cfg)
524 if (test_configuration)
526 do_test_configuration (cfg);
528 if (benchmark_send && (NULL == cpid))
530 FPRINTF (stderr, _("Option `%s' makes no sense without option `%s'.\n"),
537 if (GNUNET_OK != GNUNET_CRYPTO_hash_from_string (cpid, &pid.hashPubKey))
539 FPRINTF (stderr, _("Failed to parse peer identity `%s'\n"), cpid);
543 GNUNET_TRANSPORT_connect (cfg, NULL, NULL, ¬ify_receive,
544 ¬ify_connect, ¬ify_disconnect);
545 GNUNET_TRANSPORT_try_connect (handle, &pid);
547 GNUNET_SCHEDULER_add_delayed (benchmark_send ?
548 GNUNET_TIME_UNIT_FOREVER_REL :
549 GNUNET_TIME_UNIT_SECONDS, &do_disconnect,
552 else if (benchmark_receive)
555 GNUNET_TRANSPORT_connect (cfg, NULL, NULL, ¬ify_receive,
556 ¬ify_connect, ¬ify_disconnect);
557 GNUNET_TRANSPORT_try_connect (handle, &pid);
559 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
560 &do_disconnect, NULL);
562 if (iterate_connections)
564 GNUNET_TRANSPORT_peer_get_active_addresses (cfg, NULL, GNUNET_YES,
565 GNUNET_TIME_UNIT_MINUTES,
566 &process_address, (void *) cfg);
568 if (monitor_connections)
570 struct GNUNET_TRANSPORT_PeerIterateContext *pic;
572 pic = GNUNET_TRANSPORT_peer_get_active_addresses (cfg, NULL, GNUNET_NO,
573 GNUNET_TIME_UNIT_FOREVER_REL,
574 &process_address, (void *) cfg);
575 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
583 main (int argc, char *const *argv)
585 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
586 {'b', "benchmark", NULL,
587 gettext_noop ("measure how fast we are receiving data (until CTRL-C)"),
588 0, &GNUNET_GETOPT_set_one, &benchmark_receive},
589 {'C', "connect", "PEER",
590 gettext_noop ("try to connect to the given peer"),
591 1, &GNUNET_GETOPT_set_string, &cpid},
592 {'i', "information", NULL,
593 gettext_noop ("provide information about all current connections (once)"),
594 0, &GNUNET_GETOPT_set_one, &iterate_connections},
595 {'m', "monitor", NULL,
596 gettext_noop ("provide information about all current connections (continuously)"),
597 0, &GNUNET_GETOPT_set_one, &monitor_connections},
598 {'n', "numeric", NULL,
599 gettext_noop ("do not resolve hostnames"),
600 0, &GNUNET_GETOPT_set_one, &numeric},
603 ("send data for benchmarking to the other peer (until CTRL-C)"),
604 0, &GNUNET_GETOPT_set_one, &benchmark_send},
606 gettext_noop ("test transport configuration (involves external server)"),
607 0, &GNUNET_GETOPT_set_one, &test_configuration},
608 GNUNET_GETOPT_OPTION_VERBOSE (&verbosity),
609 GNUNET_GETOPT_OPTION_END
612 GNUNET_PROGRAM_run (argc, argv, "gnunet-transport",
614 ("Direct access to transport service."), options,
615 &run, NULL)) ? ret : 1;
619 /* end of gnunet-transport.c */