2 This file is part of GNUnet.
3 (C) 2009--2013 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)
33 #define BIG_M_STRING "unlimited"
40 static int resolve_addresses_numeric;
41 static int receive_done;
44 * For which peer should we change preference values?
48 static char *type_str;
49 static unsigned int value;
53 * Print verbose ATS information
58 * List only addresses currently used (active)
60 static int op_list_used;
65 static int op_list_all;
70 static int op_set_pref;
73 * Print quotas configured
75 static int op_print_quotas;
78 * Monitor addresses used
80 static int op_monitor;
82 static struct GNUNET_ATS_PerformanceHandle *ph;
84 static struct GNUNET_ATS_AddressListHandle *alh;
86 static struct GNUNET_CONFIGURATION_Handle *cfg;
88 static GNUNET_SCHEDULER_TaskIdentifier end_task;
90 static struct GNUNET_CONTAINER_MultiPeerMap *addresses;
93 struct PendingResolutions
95 struct PendingResolutions *next;
96 struct PendingResolutions *prev;
98 struct GNUNET_HELLO_Address *address;
99 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out;
100 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;
102 struct GNUNET_ATS_Information *ats;
105 struct GNUNET_TRANSPORT_AddressToStringContext * tats_ctx;
110 struct GNUNET_HELLO_Address *address;
111 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out;
112 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;
117 static struct PendingResolutions *head;
119 static struct PendingResolutions *tail;
122 free_addr_it (void *cls,
123 const struct GNUNET_PeerIdentity *key,
126 struct ATSAddress *a = value;
127 GNUNET_break (GNUNET_OK != GNUNET_CONTAINER_multipeermap_remove (addresses,
129 GNUNET_HELLO_address_free (a->address);
135 end(void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
137 struct PendingResolutions * pr;
138 struct PendingResolutions * next;
139 unsigned int pending;
143 GNUNET_ATS_performance_list_addresses_cancel (alh);
149 GNUNET_ATS_performance_done (ph);
155 while (NULL != (pr = next))
158 GNUNET_CONTAINER_DLL_remove(head, tail, pr);
159 GNUNET_TRANSPORT_address_to_string_cancel (pr->tats_ctx);
160 GNUNET_free(pr->address);
165 GNUNET_CONTAINER_multipeermap_iterate(addresses, &free_addr_it, NULL);
166 GNUNET_CONTAINER_multipeermap_destroy(addresses);
169 fprintf (stderr, _("%u address resolutions had a timeout\n"), pending);
170 if (op_list_used || op_list_all)
171 fprintf (stderr, _("ATS returned results for %u addresses\n"), results);
176 transport_addr_to_str_cb(void *cls, const char *address)
178 struct PendingResolutions * pr = cls;
181 char *ats_prop_arr[GNUNET_ATS_PropertyCount] = GNUNET_ATS_PropertyStrings;
182 char *ats_prop_value;
190 ats_str = GNUNET_strdup("");
191 network = GNUNET_ATS_NET_UNSPECIFIED;
192 for (c = 0; c < pr->ats_count; c++)
196 ats_type = ntohl (pr->ats[c].type);
197 ats_value = ntohl (pr->ats[c].value);
199 if (ats_type > GNUNET_ATS_PropertyCount)
201 fprintf (stderr, "Invalid ATS property type %u %u for address %s\n", ats_type, pr->ats[c].type,
208 case GNUNET_ATS_NETWORK_TYPE:
209 if (ats_value > GNUNET_ATS_NetworkTypeCount)
215 GNUNET_asprintf (&ats_prop_value, "%s",
216 GNUNET_ATS_print_network_type (ats_value));
219 GNUNET_asprintf (&ats_prop_value, "%u", ats_value);
222 if ((verbose) && (ats_type < GNUNET_ATS_PropertyCount))
224 GNUNET_asprintf (&ats_str, "%s%s=%s, ", ats_tmp, ats_prop_arr[ats_type],
226 GNUNET_free(ats_tmp);
228 GNUNET_free(ats_prop_value);
232 _("Peer `%s' plugin `%s', address `%s', `%s' bw out: %u Bytes/s, bw in %u Bytes/s, %s\n"),
233 GNUNET_i2s (&pr->address->peer), pr->address->transport_name, address,
234 GNUNET_ATS_print_network_type (network),
235 ntohl (pr->bandwidth_out.value__), ntohl (pr->bandwidth_in.value__),
237 GNUNET_free(ats_str);
242 GNUNET_CONTAINER_DLL_remove(head, tail, pr);
243 GNUNET_free(pr->address);
247 if ((GNUNET_YES == receive_done) && (0 == pending))
249 /* All messages received and no resolutions pending*/
250 if (end_task != GNUNET_SCHEDULER_NO_TASK )
251 GNUNET_SCHEDULER_cancel (end_task);
252 end_task = GNUNET_SCHEDULER_add_now (end, NULL );
258 struct AddressFindCtx
260 const struct GNUNET_HELLO_Address *src;
261 struct ATSAddress *res;
265 find_address_it (void *cls,
266 const struct GNUNET_PeerIdentity *key,
269 struct AddressFindCtx *actx = cls;
270 struct ATSAddress *exist = value;
272 if (0 == GNUNET_HELLO_address_cmp (actx->src, exist->address))
282 ats_perf_cb(void *cls, const struct GNUNET_HELLO_Address *address, int active,
283 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
284 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
285 const struct GNUNET_ATS_Information *ats, uint32_t ats_count)
287 struct PendingResolutions * pr;
289 if ((GNUNET_YES == op_monitor) && (GNUNET_NO == verbose))
291 struct AddressFindCtx actx;
296 GNUNET_CONTAINER_multipeermap_iterate (addresses, find_address_it, &actx);
297 if ((actx.res != NULL))
299 if ((bandwidth_in.value__ == actx.res->bandwidth_in.value__) &&
300 (bandwidth_out.value__ == actx.res->bandwidth_out.value__) )
302 return; /* Nothing to do here */
306 actx.res->bandwidth_in = bandwidth_in;
307 actx.res->bandwidth_out = bandwidth_out;
311 struct ATSAddress *a = GNUNET_new (struct ATSAddress);
312 a->address = GNUNET_HELLO_address_copy(address);
313 a->bandwidth_in = bandwidth_in;
314 a->bandwidth_out = bandwidth_out;
315 GNUNET_CONTAINER_multipeermap_put (addresses, &address->peer, a,
316 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
321 pr = GNUNET_malloc (sizeof (struct PendingResolutions) +
322 ats_count * sizeof (struct GNUNET_ATS_Information));
324 pr->ats_count = ats_count;
325 pr->ats = (struct GNUNET_ATS_Information *) &pr[1];
327 memcpy (pr->ats, ats, ats_count * sizeof(struct GNUNET_ATS_Information));
328 pr->address = GNUNET_HELLO_address_copy (address);
329 pr->bandwidth_in = bandwidth_in;
330 pr->bandwidth_out = bandwidth_out;
331 pr->tats_ctx = GNUNET_TRANSPORT_address_to_string (cfg, address,
332 resolve_addresses_numeric,
333 GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10),
334 transport_addr_to_str_cb, pr);
335 GNUNET_CONTAINER_DLL_insert(head, tail, pr);
341 /* All messages received */
342 receive_done = GNUNET_YES;
346 /* All messages received and no resolutions pending*/
347 if (end_task != GNUNET_SCHEDULER_NO_TASK )
348 GNUNET_SCHEDULER_cancel (end_task);
349 end_task = GNUNET_SCHEDULER_add_now (end, NULL );
355 print_quotas(const struct GNUNET_CONFIGURATION_Handle *cfg)
357 char *network_str[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
358 char * entry_in = NULL;
359 char * entry_out = NULL;
360 char * quota_out_str;
362 unsigned long long int quota_out;
363 unsigned long long int quota_in;
366 for (c = 0; (c < GNUNET_ATS_NetworkTypeCount); c++)
369 GNUNET_asprintf (&entry_out, "%s_QUOTA_OUT", network_str[c]);
370 GNUNET_asprintf (&entry_in, "%s_QUOTA_IN", network_str[c]);
374 == GNUNET_CONFIGURATION_get_value_string (cfg, "ats", entry_out,
377 if (0 == strcmp (quota_out_str, BIG_M_STRING)
379 == GNUNET_STRINGS_fancy_size_to_bytes (quota_out_str, "a_out)))
380 quota_out = UINT32_MAX;
382 GNUNET_free(quota_out_str);
383 GNUNET_asprintf ("a_out_str, "%llu", quota_out);
387 fprintf (stderr, "Outbound quota for network `%11s' not configured!\n",
389 GNUNET_asprintf ("a_out_str, "-");
391 GNUNET_free(entry_out);
395 == GNUNET_CONFIGURATION_get_value_string (cfg, "ats", entry_in,
398 if (0 == strcmp (quota_in_str, BIG_M_STRING)
400 == GNUNET_STRINGS_fancy_size_to_bytes (quota_in_str, "a_in)))
401 quota_in = UINT32_MAX;
402 GNUNET_free(quota_in_str);
403 GNUNET_asprintf ("a_in_str, "%llu", quota_in);
407 fprintf (stderr, "Inbound quota for network `%11s' not configured!\n",
409 GNUNET_asprintf ("a_in_str, "-");
411 GNUNET_free(entry_in);
413 fprintf (stderr, _("Quota for network `%11s' (in/out): %10s / %10s\n"),
414 network_str[c], quota_in_str, quota_out_str);
415 GNUNET_free(quota_out_str);
416 GNUNET_free(quota_in_str);
418 return GNUNET_ATS_NetworkTypeCount;
422 testservice_ats(void *cls, int result)
424 struct GNUNET_CONFIGURATION_Handle *cfg = cls;
425 struct GNUNET_PeerIdentity pid;
429 addresses = GNUNET_CONTAINER_multipeermap_create (10, GNUNET_YES);
431 if (GNUNET_YES != result)
433 FPRINTF (stderr, _("Service `%s' is not running\n"), "ats");
442 != GNUNET_CRYPTO_eddsa_public_key_from_string (pid_str,
443 strlen (pid_str), &pid.public_key))
445 FPRINTF (stderr, _("Failed to parse peer identity `%s'\n"), pid_str);
450 c = op_list_all + op_list_used + op_monitor + op_set_pref;
454 _("Please select one operation : %s or %s or %s or %s or %s\n"),
455 "--used", "--all", "--monitor", "--preference", "--quotas");
459 op_list_used = GNUNET_YES; /* set default */
462 ret = print_quotas (cfg);
467 ph = GNUNET_ATS_performance_init (cfg, NULL, NULL );
470 fprintf (stderr, _("Cannot connect to ATS service, exiting...\n") );
474 alh = GNUNET_ATS_performance_list_addresses (ph,
475 (NULL == pid_str) ? NULL : &pid, GNUNET_YES, ats_perf_cb, NULL );
478 fprintf (stderr, _("Cannot issue request to ATS service, exiting...\n") );
479 end_task = GNUNET_SCHEDULER_add_now (&end, NULL );
482 end_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &end,
485 else if (op_list_used)
487 ph = GNUNET_ATS_performance_init (cfg, NULL, NULL );
489 fprintf (stderr, _("Cannot connect to ATS service, exiting...\n") );
491 alh = GNUNET_ATS_performance_list_addresses (ph,
492 (NULL == pid_str) ? NULL : &pid, GNUNET_NO, ats_perf_cb, NULL );
495 fprintf (stderr, _("Cannot issue request to ATS service, exiting...\n") );
496 end_task = GNUNET_SCHEDULER_add_now (&end, NULL );
499 end_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &end,
504 ph = GNUNET_ATS_performance_init (cfg, &ats_perf_cb, NULL );
506 fprintf (stderr, _("Cannot connect to ATS service, exiting...\n") );
507 end_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &end,
511 else if (op_set_pref)
513 if (NULL == type_str)
515 fprintf (stderr, _("No preference type given!\n") );
520 fprintf (stderr, _("No peer given!\n") );
524 for (c = 0; c < strlen (type_str); c++)
526 if (isupper (type_str[c]))
527 type_str[c] = tolower (type_str[c]);
530 if (0 == strcasecmp ("latency", type_str))
531 type = GNUNET_ATS_PREFERENCE_LATENCY;
532 else if (0 == strcasecmp ("bandwidth", type_str))
533 type = GNUNET_ATS_PREFERENCE_BANDWIDTH;
536 FPRINTF (stderr, "%s", _("Valid type required\n") );
541 ph = GNUNET_ATS_performance_init (cfg, NULL, NULL );
543 fprintf (stderr, _("Cannot connect to ATS service, exiting...\n") );
545 GNUNET_ATS_performance_change_preference (ph, &pid, type, (double) value,
546 GNUNET_ATS_PREFERENCE_END);
548 end_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS, &end,
555 * Main function that will be run by the scheduler.
558 * @param args remaining command-line arguments
559 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
560 * @param my_cfg configuration
563 run(void *cls, char * const *args, const char *cfgfile,
564 const struct GNUNET_CONFIGURATION_Handle *my_cfg)
566 cfg = (struct GNUNET_CONFIGURATION_Handle *) my_cfg;
567 GNUNET_CLIENT_service_test ("ats", cfg, TIMEOUT, &testservice_ats,
574 * @param argc number of arguments from the command line
575 * @param argv command line arguments
576 * @return 0 ok, 1 on error
579 main(int argc, char * const *argv)
582 resolve_addresses_numeric = GNUNET_NO;
583 op_monitor = GNUNET_NO;
584 op_list_all = GNUNET_NO;
585 op_list_used = GNUNET_NO;
586 op_set_pref = GNUNET_NO;
588 receive_done = GNUNET_NO;
591 static const struct GNUNET_GETOPT_CommandLineOption options[] =
594 gettext_noop ("get list of active addresses currently used"), 0,
595 &GNUNET_GETOPT_set_one, &op_list_used },
596 { 'a', "all", NULL, gettext_noop ("get list of all active addresses"), 0,
597 &GNUNET_GETOPT_set_one, &op_list_all },
598 { 'n', "numeric", NULL,
599 gettext_noop ("do not resolve IP addresses to hostnames"), 0,
600 &GNUNET_GETOPT_set_one, &resolve_addresses_numeric },
601 { 'm', "monitor", NULL, gettext_noop ("monitor mode"), 0,
602 &GNUNET_GETOPT_set_one, &op_monitor },
603 { 'p', "preference", NULL, gettext_noop ("set preference for the given peer"),
604 0, &GNUNET_GETOPT_set_one, &op_set_pref },
605 { 'q', "quotas", NULL, gettext_noop ("print all configured quotas"), 0,
606 &GNUNET_GETOPT_set_one, &op_print_quotas },
607 { 'i', "id", "TYPE", gettext_noop ("peer id"), 1, &GNUNET_GETOPT_set_string,
609 { 't', "type", "TYPE",
610 gettext_noop ("preference type to set: latency | bandwidth"), 1,
611 &GNUNET_GETOPT_set_string, &type_str },
612 { 'k', "value", "VALUE", gettext_noop ("preference value"), 1,
613 &GNUNET_GETOPT_set_uint, &value },
614 { 'V', "verbose", NULL,
615 gettext_noop ("verbose output (include ATS address properties)"), 0,
616 &GNUNET_GETOPT_set_one, &verbose }, GNUNET_GETOPT_OPTION_END };
618 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
621 res = GNUNET_PROGRAM_run (argc, argv, "gnunet-ats",
622 gettext_noop ("Print information about ATS state"), options, &run, NULL );
623 GNUNET_free_non_null(pid_str);
624 GNUNET_free_non_null(type_str);
625 GNUNET_free((void * ) argv);
627 if (GNUNET_OK == res)
634 /* end of gnunet-ats.c */