/* This file is part of GNUnet. (C) 2011 Christian Grothoff (and other contributing authors) GNUnet is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version. GNUnet is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNUnet; see the file COPYING. If not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ /** * @file src/transport/gnunet-transport.c * @brief Tool to help configure, measure and control the transport subsystem. * @author Christian Grothoff * @author Nathan Evans * * This utility can be used to test if a transport mechanism for * GNUnet is properly configured. */ #include "platform.h" #include "gnunet_util_lib.h" #include "gnunet_resolver_service.h" #include "gnunet_protocols.h" #include "gnunet_transport_service.h" #include "gnunet_nat_lib.h" /** * How long do we wait for the NAT test to report success? * Should match NAT_SERVER_TIMEOUT in 'nat_test.c'. */ #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30) #define RESOLUTION_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10) /** * Which peer should we connect to? */ static char *cpid; /** * Handle to transport service. */ static struct GNUNET_TRANSPORT_Handle *handle; /** * Option -s. */ static int benchmark_send; /** * Option -b. */ static int benchmark_receive; /** * Option -l. */ static int benchmark_receive; /** * Option -i. */ static int iterate_connections; /** * Option -t. */ static int test_configuration; /** * Option -m. */ static int monitor_connections; /** * Option -n. */ static int numeric; /** * Global return value (0 success). */ static int ret; /** * Number of bytes of traffic we received so far. */ static unsigned long long traffic_received; /** * Number of bytes of traffic we sent so far. */ static unsigned long long traffic_sent; /** * Starting time of transmitting/receiving data. */ static struct GNUNET_TIME_Absolute start_time; /** * Handle for current transmission request. */ static struct GNUNET_TRANSPORT_TransmitHandle *th; /** * Identity of the peer we transmit to / connect to. * (equivalent to 'cpid' string). */ static struct GNUNET_PeerIdentity pid; /** * Task scheduled for cleanup / termination of the process. */ static GNUNET_SCHEDULER_TaskIdentifier end; static struct GNUNET_CONTAINER_MultiHashMap *peers; /** * Selected level of verbosity. */ static int verbosity; /** * Resolver process handle. */ struct GNUNET_OS_Process *resolver; /** * Number of tasks running that still need the resolver. */ static unsigned int resolver_users; /** * Context for a plugin test. */ struct TestContext { /** * Handle to the active NAT test. */ struct GNUNET_NAT_Test *tst; /** * Task identifier for the timeout. */ GNUNET_SCHEDULER_TaskIdentifier tsk; /** * Name of plugin under test. */ const char *name; }; /** * Display the result of the test. * * @param tc test context * @param result GNUNET_YES on success */ static void display_test_result (struct TestContext *tc, int result) { if (GNUNET_YES != result) { FPRINTF (stderr, "Configuration for plugin `%s' did not work!\n", tc->name); } else { FPRINTF (stderr, "Configuration for plugin `%s' is working!\n", tc->name); } if (GNUNET_SCHEDULER_NO_TASK != tc->tsk) { GNUNET_SCHEDULER_cancel (tc->tsk); tc->tsk = GNUNET_SCHEDULER_NO_TASK; } if (NULL != tc->tst) { GNUNET_NAT_test_stop (tc->tst); tc->tst = NULL; } GNUNET_free (tc); resolver_users--; if ((0 == resolver_users) && (NULL != resolver)) { GNUNET_break (0 == GNUNET_OS_process_kill (resolver, SIGTERM)); GNUNET_OS_process_destroy (resolver); resolver = NULL; } } /** * Function called by NAT on success. * Clean up and update GUI (with success). * * @param cls test context * @param success currently always GNUNET_OK */ static void result_callback (void *cls, int success) { struct TestContext *tc = cls; display_test_result (tc, success); } /** * Function called if NAT failed to confirm success. * Clean up and update GUI (with failure). * * @param cls test context * @param tc scheduler callback */ static void fail_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc) { struct TestContext *tstc = cls; tstc->tsk = GNUNET_SCHEDULER_NO_TASK; display_test_result (tstc, GNUNET_NO); } /** * Test our plugin's configuration (NAT traversal, etc.). * * @param cfg configuration to test */ static void do_test_configuration (const struct GNUNET_CONFIGURATION_Handle *cfg) { char *plugins; char *tok; unsigned long long bnd_port; unsigned long long adv_port; struct TestContext *tc; if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg, "transport", "plugins", &plugins)) { FPRINTF (stderr, "%s", _ ("No transport plugins configured, peer will never communicate\n")); ret = 4; return; } for (tok = strtok (plugins, " "); tok != NULL; tok = strtok (NULL, " ")) { char section[12 + strlen (tok)]; GNUNET_snprintf (section, sizeof (section), "transport-%s", tok); if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (cfg, section, "PORT", &bnd_port)) { FPRINTF (stderr, _("No port configured for plugin `%s', cannot test it\n"), tok); continue; } if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (cfg, section, "ADVERTISED_PORT", &adv_port)) adv_port = bnd_port; if (NULL == resolver) resolver = GNUNET_OS_start_process (GNUNET_YES, NULL, NULL, "gnunet-service-resolver", "gnunet-service-resolver", NULL); resolver_users++; GNUNET_RESOLVER_connect (cfg); tc = GNUNET_malloc (sizeof (struct TestContext)); tc->name = GNUNET_strdup (tok); tc->tst = GNUNET_NAT_test_start (cfg, (0 == strcasecmp (tok, "udp")) ? GNUNET_NO : GNUNET_YES, (uint16_t) bnd_port, (uint16_t) adv_port, &result_callback, tc); if (NULL == tc->tst) { display_test_result (tc, GNUNET_SYSERR); continue; } tc->tsk = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &fail_timeout, tc); } GNUNET_free (plugins); } /** * Shutdown, print statistics. */ static void do_disconnect (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc) { struct GNUNET_TIME_Relative duration; if (NULL != th) { GNUNET_TRANSPORT_notify_transmit_ready_cancel (th); th = NULL; } GNUNET_TRANSPORT_disconnect (handle); if (benchmark_receive) { duration = GNUNET_TIME_absolute_get_duration (start_time); FPRINTF (stdout, _("Received %llu bytes/s (%llu bytes in %llu ms)\n"), 1000 * traffic_received / (1 + duration.rel_value), traffic_received, (unsigned long long) duration.rel_value); } if (benchmark_send) { duration = GNUNET_TIME_absolute_get_duration (start_time); FPRINTF (stdout, _("Transmitted %llu bytes/s (%llu bytes in %llu ms)\n"), 1000 * traffic_sent / (1 + duration.rel_value), traffic_sent, (unsigned long long) duration.rel_value); } } /** * Function called to notify a client about the socket * begin ready to queue more data. "buf" will be * NULL and "size" zero if the socket was closed for * writing in the meantime. * * @param cls closure * @param size number of bytes available in buf * @param buf where the callee should write the message * @return number of bytes written to buf */ static size_t transmit_data (void *cls, size_t size, void *buf) { struct GNUNET_MessageHeader *m = buf; GNUNET_assert (size >= sizeof (struct GNUNET_MessageHeader)); GNUNET_assert (size < GNUNET_SERVER_MAX_MESSAGE_SIZE); m->size = ntohs (size); m->type = ntohs (GNUNET_MESSAGE_TYPE_DUMMY); memset (&m[1], 52, size - sizeof (struct GNUNET_MessageHeader)); traffic_sent += size; th = GNUNET_TRANSPORT_notify_transmit_ready (handle, &pid, 32 * 1024, 0, GNUNET_TIME_UNIT_FOREVER_REL, &transmit_data, NULL); if (verbosity > 0) FPRINTF (stdout, _("Transmitting %u bytes to %s\n"), (unsigned int) size, GNUNET_i2s (&pid)); return size; } /** * Function called to notify transport users that another * peer connected to us. * * @param cls closure * @param peer the peer that connected * @param ats performance data * @param ats_count number of entries in ats (excluding 0-termination) */ static void notify_connect (void *cls, const struct GNUNET_PeerIdentity *peer, const struct GNUNET_ATS_Information *ats, uint32_t ats_count) { if (verbosity > 0) FPRINTF (stdout, _("Connected to %s\n"), GNUNET_i2s (peer)); if (0 != memcmp (&pid, peer, sizeof (struct GNUNET_PeerIdentity))) return; ret = 0; if (benchmark_send) { start_time = GNUNET_TIME_absolute_get (); th = GNUNET_TRANSPORT_notify_transmit_ready (handle, peer, 32 * 1024, 0, GNUNET_TIME_UNIT_FOREVER_REL, &transmit_data, NULL); } else { /* all done, terminate instantly */ GNUNET_SCHEDULER_cancel (end); end = GNUNET_SCHEDULER_add_now (&do_disconnect, NULL); } } /** * Function called to notify transport users that another * peer disconnected from us. * * @param cls closure * @param peer the peer that disconnected */ static void notify_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer) { if (verbosity > 0) FPRINTF (stdout, _("Disconnected from %s\n"), GNUNET_i2s (peer)); if ((0 == memcmp (&pid, peer, sizeof (struct GNUNET_PeerIdentity))) && (NULL != th)) { GNUNET_TRANSPORT_notify_transmit_ready_cancel (th); th = NULL; GNUNET_SCHEDULER_cancel (end); end = GNUNET_SCHEDULER_add_now (&do_disconnect, NULL); } } /** * Function called by the transport for each received message. * * @param cls closure * @param peer (claimed) identity of the other peer * @param message the message * @param ats performance data * @param ats_count number of entries in ats */ static void notify_receive (void *cls, const struct GNUNET_PeerIdentity *peer, const struct GNUNET_MessageHeader *message, const struct GNUNET_ATS_Information *ats, uint32_t ats_count) { if (!benchmark_receive) return; if (verbosity > 0) FPRINTF (stdout, _("Received %u bytes from %s\n"), (unsigned int) ntohs (message->size), GNUNET_i2s (peer)); if (traffic_received == 0) start_time = GNUNET_TIME_absolute_get (); traffic_received += ntohs (message->size); } struct ResolutionContext { struct GNUNET_HELLO_Address *addrcp; int printed; }; static void process_string (void *cls, const char *address) { struct ResolutionContext *rc = cls; struct GNUNET_HELLO_Address *addrcp = rc->addrcp; if (address != NULL) { FPRINTF (stdout, _("Peer `%s': %s %s\n"), GNUNET_i2s (&addrcp->peer), addrcp->transport_name, address); rc->printed = GNUNET_YES; } else { /* done */ if (GNUNET_NO == rc->printed) FPRINTF (stdout, _("Peer `%s': %s \n"), GNUNET_i2s (&addrcp->peer), addrcp->transport_name); GNUNET_free (rc->addrcp); GNUNET_free (rc); } } /** * Function to call with a binary address * * @param cls closure * @param peer identity of the peer * @param address binary address (NULL on disconnect) */ static void process_address (void *cls, const struct GNUNET_PeerIdentity *peer, const struct GNUNET_HELLO_Address *address) { const struct GNUNET_CONFIGURATION_Handle *cfg = cls; struct ResolutionContext *rc; if (peer == NULL) { /* done */ return; } if (address == NULL) { FPRINTF (stdout, _("Peer `%s' disconnected\n"), GNUNET_i2s (peer)); return; } rc = GNUNET_malloc(sizeof (struct ResolutionContext)); rc->addrcp = GNUNET_HELLO_address_copy(address); rc->printed = GNUNET_NO; GNUNET_assert (NULL != rc); /* Resolve address to string */ GNUNET_TRANSPORT_address_to_string (cfg, address, numeric, RESOLUTION_TIMEOUT, &process_string, rc); } /** * Task run in monitor mode when the user presses CTRL-C to abort. * Stops monitoring activity. * * @param cls the 'struct GNUNET_TRANSPORT_PeerIterateContext *' * @param tc scheduler context */ static void shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc) { struct GNUNET_TRANSPORT_PeerIterateContext *pic = cls; GNUNET_TRANSPORT_peer_get_active_addresses_cancel (pic); if (NULL != peers) { GNUNET_CONTAINER_multihashmap_destroy (peers); peers = NULL; } } /** * Main function that will be run by the scheduler. * * @param cls closure * @param args remaining command-line arguments * @param cfgfile name of the configuration file used (for saving, can be NULL!) * @param cfg configuration */ static void run (void *cls, char *const *args, const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *cfg) { if (test_configuration) { do_test_configuration (cfg); } if (benchmark_send && (NULL == cpid)) { FPRINTF (stderr, _("Option `%s' makes no sense without option `%s'.\n"), "-s", "-C"); return; } if (NULL != cpid) { ret = 1; if (GNUNET_OK != GNUNET_CRYPTO_hash_from_string (cpid, &pid.hashPubKey)) { FPRINTF (stderr, _("Failed to parse peer identity `%s'\n"), cpid); return; } handle = GNUNET_TRANSPORT_connect (cfg, NULL, NULL, ¬ify_receive, ¬ify_connect, ¬ify_disconnect); GNUNET_TRANSPORT_try_connect (handle, &pid); end = GNUNET_SCHEDULER_add_delayed (benchmark_send ? GNUNET_TIME_UNIT_FOREVER_REL : GNUNET_TIME_UNIT_SECONDS, &do_disconnect, NULL); } else if (benchmark_receive) { handle = GNUNET_TRANSPORT_connect (cfg, NULL, NULL, ¬ify_receive, ¬ify_connect, ¬ify_disconnect); GNUNET_TRANSPORT_try_connect (handle, &pid); end = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &do_disconnect, NULL); } if (iterate_connections) { peers = GNUNET_CONTAINER_multihashmap_create (20); GNUNET_TRANSPORT_peer_get_active_addresses (cfg, NULL, GNUNET_YES, TIMEOUT, &process_address, (void *) cfg); } if (monitor_connections) { struct GNUNET_TRANSPORT_PeerIterateContext *pic; pic = GNUNET_TRANSPORT_peer_get_active_addresses (cfg, NULL, GNUNET_NO, GNUNET_TIME_UNIT_FOREVER_REL, &process_address, (void *) cfg); GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task, pic); } } int main (int argc, char *const *argv) { static const struct GNUNET_GETOPT_CommandLineOption options[] = { {'b', "benchmark", NULL, gettext_noop ("measure how fast we are receiving data (until CTRL-C)"), 0, &GNUNET_GETOPT_set_one, &benchmark_receive}, {'C', "connect", "PEER", gettext_noop ("try to connect to the given peer"), 1, &GNUNET_GETOPT_set_string, &cpid}, {'i', "information", NULL, gettext_noop ("provide information about all current connections (once)"), 0, &GNUNET_GETOPT_set_one, &iterate_connections}, {'m', "monitor", NULL, gettext_noop ("provide information about all current connections (continuously)"), 0, &GNUNET_GETOPT_set_one, &monitor_connections}, {'n', "numeric", NULL, gettext_noop ("do not resolve hostnames"), 0, &GNUNET_GETOPT_set_one, &numeric}, {'s', "send", NULL, gettext_noop ("send data for benchmarking to the other peer (until CTRL-C)"), 0, &GNUNET_GETOPT_set_one, &benchmark_send}, {'t', "test", NULL, gettext_noop ("test transport configuration (involves external server)"), 0, &GNUNET_GETOPT_set_one, &test_configuration}, GNUNET_GETOPT_OPTION_VERBOSE (&verbosity), GNUNET_GETOPT_OPTION_END }; return (GNUNET_OK == GNUNET_PROGRAM_run (argc, argv, "gnunet-transport", gettext_noop ("Direct access to transport service."), options, &run, NULL)) ? ret : 1; } /* end of gnunet-transport.c */