2 This file is part of GNUnet.
3 (C) 2001, 2002, 2004, 2005, 2006, 2007, 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 ats-tool/gnunet-ats.c
23 * @brief ATS command line tool
24 * @author Matthias Wachs
27 #include "gnunet_util_lib.h"
28 #include "gnunet_ats_service.h"
29 #include "gnunet_transport_service.h"
31 #define TIMEOUT GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 5)
38 static int resolve_addresses_numeric;
39 static int receive_done;
42 * For which peer should we change preference values?
46 static char *type_str;
47 static unsigned int value;
51 * Print verbose ATS information
56 * List only addresses currently used (active)
58 static int op_list_used;
63 static int op_list_all;
68 static int op_set_pref;
71 * Monitor addresses used
73 static int op_monitor;
77 static struct GNUNET_ATS_PerformanceHandle *ph;
79 struct GNUNET_ATS_AddressListHandle *alh;
81 static struct GNUNET_CONFIGURATION_Handle *cfg;
83 GNUNET_SCHEDULER_TaskIdentifier end_task;
85 struct PendingResolutions
87 struct PendingResolutions *next;
88 struct PendingResolutions *prev;
90 struct GNUNET_HELLO_Address *address;
91 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out;
92 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;
94 struct GNUNET_ATS_Information *ats;
97 struct GNUNET_TRANSPORT_AddressToStringContext * tats_ctx;
100 struct PendingResolutions *head;
101 struct PendingResolutions *tail;
104 const struct GNUNET_SCHEDULER_TaskContext *tc)
106 struct PendingResolutions * pr;
107 struct PendingResolutions * next;
108 unsigned int pending;
112 GNUNET_ATS_performance_list_addresses_cancel (alh);
118 GNUNET_ATS_performance_done (ph);
124 while (NULL != (pr = next))
127 GNUNET_CONTAINER_DLL_remove (head, tail, pr);
128 GNUNET_TRANSPORT_address_to_string_cancel (pr->tats_ctx);
129 GNUNET_free (pr->address);
134 fprintf (stderr, _("%u address resolutions had a timeout\n"), pending);
136 fprintf (stderr, _("ATS returned results for %u addresses\n"), results);
141 void transport_addr_to_str_cb (void *cls, const char *address)
143 struct PendingResolutions * pr = cls;
146 char *ats_prop_arr[GNUNET_ATS_PropertyCount] = GNUNET_ATS_PropertyStrings;
147 char *ats_net_arr[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
148 char *ats_prop_value;
154 ats_str = GNUNET_strdup("");
157 for (c = 0; c < pr->ats_count; c++)
161 ats_type = ntohl(pr->ats[c].type);
162 ats_value = ntohl(pr->ats[c].value);
164 if (ats_type > GNUNET_ATS_PropertyCount)
171 case GNUNET_ATS_NETWORK_TYPE:
172 if (ats_value > GNUNET_ATS_NetworkTypeCount)
177 GNUNET_asprintf (&ats_prop_value, "%s", ats_net_arr[ats_value]);
180 GNUNET_asprintf (&ats_prop_value, "%u", ats_value);
184 GNUNET_asprintf (&ats_str, "%s%s=%s, ", ats_tmp, ats_prop_arr[ats_type] , ats_prop_value);
185 GNUNET_free (ats_tmp);
186 GNUNET_free (ats_prop_value);
190 fprintf (stderr, _("Peer `%s' plugin `%s', address `%s', bw out: %u Bytes/s, bw in %u Bytes/s, %s\n"),
191 GNUNET_i2s (&pr->address->peer), pr->address->transport_name, address,
192 ntohl (pr->bandwidth_out.value__), ntohl (pr->bandwidth_in.value__),ats_str);
193 GNUNET_free (ats_str);
198 GNUNET_CONTAINER_DLL_remove (head, tail, pr);
199 GNUNET_free (pr->address);
203 if ((GNUNET_YES == receive_done) && (0 == pending))
205 /* All messages received and no resolutions pending*/
206 if (end_task != GNUNET_SCHEDULER_NO_TASK)
207 GNUNET_SCHEDULER_cancel (end_task);
208 end_task = GNUNET_SCHEDULER_add_now (end, NULL);
213 void ats_perf_cb (void *cls,
215 GNUNET_HELLO_Address *
218 GNUNET_BANDWIDTH_Value32NBO
221 GNUNET_BANDWIDTH_Value32NBO
224 GNUNET_ATS_Information *
225 ats, uint32_t ats_count)
227 struct PendingResolutions * pr;
232 pr = GNUNET_malloc (sizeof (struct PendingResolutions) +
233 ats_count * sizeof (struct GNUNET_ATS_Information));
235 pr->ats_count = ats_count;
236 pr->ats = (struct GNUNET_ATS_Information *) &pr[1];
238 memcpy (pr->ats, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
239 pr->address = GNUNET_HELLO_address_copy (address);
240 pr->bandwidth_in = bandwidth_in;
241 pr->bandwidth_out = bandwidth_out;
242 pr->tats_ctx = GNUNET_TRANSPORT_address_to_string(cfg, address,
243 resolve_addresses_numeric, GNUNET_TIME_UNIT_FOREVER_REL, transport_addr_to_str_cb, pr);
244 GNUNET_CONTAINER_DLL_insert (head, tail, pr);
250 /* All messages received */
251 receive_done = GNUNET_YES;
255 /* All messages received and no resolutions pending*/
256 if (end_task != GNUNET_SCHEDULER_NO_TASK)
257 GNUNET_SCHEDULER_cancel (end_task);
258 end_task = GNUNET_SCHEDULER_add_now (end, NULL);
264 void testservice_ats (void *cls,
265 const struct GNUNET_SCHEDULER_TaskContext *tc)
267 struct GNUNET_PeerIdentity pid;
268 struct GNUNET_CONFIGURATION_Handle *cfg = cls;
272 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_TIMEOUT))
274 FPRINTF (stderr, _("Service `%s' is not running\n"), "ats");
282 if (GNUNET_OK != GNUNET_CRYPTO_hash_from_string (pid_str, &pid.hashPubKey))
284 FPRINTF (stderr, _("Failed to parse peer identity `%s'\n"), pid_str);
289 c = op_list_all + op_list_used + op_monitor + op_set_pref;
292 FPRINTF (stderr, _("Please select one operation : %s or %s or %s or %s\n"),
293 "--used", "--all", "--monitor", "--preference");
297 op_list_used = GNUNET_YES; /* set default */
302 ph = GNUNET_ATS_performance_init (cfg, NULL, NULL);
305 fprintf (stderr, _("Cannot connect to ATS service, exiting...\n"));
309 alh = GNUNET_ATS_performance_list_addresses (ph,
310 (NULL == pid_str) ? NULL : &pid,
311 GNUNET_YES, ats_perf_cb, NULL);
314 fprintf (stderr, _("Cannot issue request to ATS service, exiting...\n"));
315 end_task = GNUNET_SCHEDULER_add_now (&end, NULL);
318 end_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &end, NULL);
320 else if (op_list_used)
322 ph = GNUNET_ATS_performance_init (cfg, NULL, NULL);
324 fprintf (stderr, _("Cannot connect to ATS service, exiting...\n"));
326 alh = GNUNET_ATS_performance_list_addresses (ph,
327 (NULL == pid_str) ? NULL : &pid,
328 GNUNET_NO, ats_perf_cb, NULL);
331 fprintf (stderr, _("Cannot issue request to ATS service, exiting...\n"));
332 end_task = GNUNET_SCHEDULER_add_now (&end, NULL);
335 end_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &end, NULL);
339 ph = GNUNET_ATS_performance_init (cfg, ats_perf_cb, NULL);
341 fprintf (stderr, _("Cannot connect to ATS service, exiting...\n"));
342 end_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &end, NULL);
345 else if (op_set_pref)
347 for (c = 0; c<strlen(type_str); c++)
349 if (isupper (type_str[c]))
350 type_str[c] = tolower (type_str[c]);
353 if (0 == strcasecmp("latency", type_str))
354 type = GNUNET_ATS_PREFERENCE_LATENCY;
355 else if (0 == strcasecmp("bandwidth", type_str))
356 type = GNUNET_ATS_PREFERENCE_BANDWIDTH;
359 FPRINTF (stderr, "%s", _("Type required\n"));
364 ph = GNUNET_ATS_performance_init (cfg, NULL, NULL);
366 fprintf (stderr, _("Cannot connect to ATS service, exiting...\n"));
368 GNUNET_ATS_change_preference (ph, &pid, type, (double) value, GNUNET_ATS_PREFERENCE_END);
370 end_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS, &end, NULL);
376 * Main function that will be run by the scheduler.
379 * @param args remaining command-line arguments
380 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
381 * @param my_cfg configuration
384 run (void *cls, char *const *args, const char *cfgfile,
385 const struct GNUNET_CONFIGURATION_Handle *my_cfg)
387 cfg = (struct GNUNET_CONFIGURATION_Handle *) my_cfg;
388 GNUNET_CLIENT_service_test ("ats", cfg,
398 * @param argc number of arguments from the command line
399 * @param argv command line arguments
400 * @return 0 ok, 1 on error
403 main (int argc, char *const *argv)
406 resolve_addresses_numeric = GNUNET_NO;
407 op_monitor = GNUNET_NO;
408 op_list_all = GNUNET_NO;
409 op_list_used = GNUNET_NO;
410 op_set_pref = GNUNET_NO;
412 receive_done = GNUNET_NO;
414 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
416 gettext_noop ("get list of active addresses currently used"),
417 0, &GNUNET_GETOPT_set_one, &op_list_used},
419 gettext_noop ("get list of all active addresses"),
420 0, &GNUNET_GETOPT_set_one, &op_list_all},
421 {'n', "numeric", NULL,
422 gettext_noop ("do not resolve IP addresses to hostnames"),
423 0, &GNUNET_GETOPT_set_one, &resolve_addresses_numeric},
424 {'m', "monitor", NULL,
425 gettext_noop ("monitor mode"),
426 0, &GNUNET_GETOPT_set_one, &op_monitor},
427 {'p', "preference", NULL,
428 gettext_noop ("set preference for the given peer"),
429 0, &GNUNET_GETOPT_set_one, &op_set_pref},
431 gettext_noop ("peer id"),
432 1, &GNUNET_GETOPT_set_string, &pid_str},
433 {'t', "type", "TYPE",
434 gettext_noop ("preference type to set: latency | bandwidth"),
435 1, &GNUNET_GETOPT_set_string, &type_str},
436 {'k', "value", "VALUE",
437 gettext_noop ("preference value"),
438 1, &GNUNET_GETOPT_set_uint, &value},
439 {'V', "verbose", NULL,
440 gettext_noop ("verbose output (include ATS address properties)"),
441 0, &GNUNET_GETOPT_set_one, &verbose},
442 GNUNET_GETOPT_OPTION_END
445 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
448 res = GNUNET_PROGRAM_run (argc, argv, "gnunet-ats",
449 gettext_noop ("Print information about ATS state"), options, &run,
451 GNUNET_free_non_null (pid_str);
452 GNUNET_free_non_null (type_str);
453 GNUNET_free ((void *) argv);
455 if (GNUNET_OK == res)
462 /* end of gnunet-ats.c */