2 This file is part of GNUnet.
3 Copyright (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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @file statistics/gnunet-statistics.c
23 * @brief tool to obtain statistics
24 * @author Christian Grothoff
25 * @author Igor Wronsky
28 #include "gnunet_util_lib.h"
29 #include "gnunet_statistics_service.h"
30 #include "statistics.h"
32 #define GET_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
40 * Set to subsystem that we're going to get stats for (or NULL for all).
42 static char *subsystem;
45 * Set to the specific stat value that we are after (or NULL for all).
50 * Make the value that is being set persistent.
52 static int persistent;
55 * Watch value continuously
67 static char *remote_host;
72 static unsigned long long remote_port;
77 static unsigned long long set_val;
86 * Callback function to process statistic values.
89 * @param subsystem name of subsystem that created the statistic
90 * @param name the name of the datum
91 * @param value the current value
92 * @param is_persistent #GNUNET_YES if the value is persistent, #GNUNET_NO if not
93 * @return #GNUNET_OK to continue, #GNUNET_SYSERR to abort iteration
97 const char *subsystem,
102 struct GNUNET_TIME_Absolute now = GNUNET_TIME_absolute_get();
103 const char * now_str;
105 if (quiet == GNUNET_NO)
107 if (GNUNET_YES == watch)
109 now_str = GNUNET_STRINGS_absolute_time_to_string(now);
110 FPRINTF (stdout, "%24s %s%12s %50s: %16llu \n",
112 is_persistent ? "!" : " ",
113 subsystem, _(name), (unsigned long long) value);
117 FPRINTF (stdout, "%s%12s %50s: %16llu \n",
118 is_persistent ? "!" : " ",
119 subsystem, _(name), (unsigned long long) value);
123 FPRINTF (stdout, "%llu\n", (unsigned long long) value);
130 * Function called last by the statistics code.
133 * @param success #GNUNET_OK if statistics were
134 * successfully obtained, #GNUNET_SYSERR if not.
137 cleanup (void *cls, int success)
140 if (success != GNUNET_OK)
142 if (NULL == remote_host)
145 _("Failed to obtain statistics.\n"));
148 _("Failed to obtain statistics from host `%s:%llu'\n"),
153 GNUNET_SCHEDULER_shutdown ();
158 * Function run on shutdown to clean up.
160 * @param cls the statistics handle
161 * @param tc scheduler context
164 shutdown_task (void *cls,
165 const struct GNUNET_SCHEDULER_TaskContext *tc)
167 struct GNUNET_STATISTICS_Handle *h = cls;
171 if ( (GNUNET_YES == watch) &&
172 (NULL != subsystem) &&
174 GNUNET_assert (GNUNET_OK ==
175 GNUNET_STATISTICS_watch_cancel (h, subsystem, name, &printer, h));
176 GNUNET_STATISTICS_destroy (h, GNUNET_NO);
182 * Main task that does the actual work.
184 * @param cls closure with our configuration
185 * @param tc schedueler context
188 main_task (void *cls,
189 const struct GNUNET_SCHEDULER_TaskContext *tc)
191 const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
192 struct GNUNET_STATISTICS_Handle *h;
196 if (NULL == subsystem)
198 FPRINTF (stderr, "%s", _("Missing argument: subsystem \n"));
204 FPRINTF (stderr, "%s", _("Missing argument: name\n"));
208 h = GNUNET_STATISTICS_create (subsystem, cfg);
214 GNUNET_STATISTICS_set (h, name, (uint64_t) set_val, persistent);
215 GNUNET_STATISTICS_destroy (h, GNUNET_YES);
219 if (NULL == (h = GNUNET_STATISTICS_create ("gnunet-statistics", cfg)))
224 if (GNUNET_NO == watch)
227 GNUNET_STATISTICS_get (h, subsystem, name, GET_TIMEOUT, &cleanup,
229 cleanup (h, GNUNET_SYSERR);
233 if ((NULL == subsystem) || (NULL == name))
235 printf (_("No subsystem or name given\n"));
236 GNUNET_STATISTICS_destroy (h, GNUNET_NO);
241 if (GNUNET_OK != GNUNET_STATISTICS_watch (h, subsystem, name, &printer, h))
243 fprintf (stderr, _("Failed to initialize watch routine\n"));
244 GNUNET_SCHEDULER_add_now (&shutdown_task, h);
248 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
254 * Function called with th test result to see if the resolver is
257 * @param cls closure with our configuration
258 * @param result #GNUNET_YES if the resolver is running
261 resolver_test_task (void *cls,
264 struct GNUNET_CONFIGURATION_Handle *cfg = cls;
266 if (GNUNET_YES != result)
269 _("Trying to connect to remote host, but service `%s' is not running\n"),
273 /* connect to a remote host */
274 if (0 == remote_port)
277 GNUNET_CONFIGURATION_get_value_number (cfg, "statistics",
282 _("A port is required to connect to host `%s'\n"),
287 else if (65535 <= remote_port)
290 _("A port has to be between 1 and 65535 to connect to host `%s'\n"),
295 /* Manipulate configuration */
296 GNUNET_CONFIGURATION_set_value_string (cfg,
297 "statistics", "UNIXPATH", "");
298 GNUNET_CONFIGURATION_set_value_string (cfg,
299 "statistics", "HOSTNAME", remote_host);
300 GNUNET_CONFIGURATION_set_value_number (cfg,
301 "statistics", "PORT", remote_port);
302 GNUNET_SCHEDULER_add_now (&main_task, cfg);
307 * Main function that will be run by the scheduler.
310 * @param args remaining command-line arguments
311 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
312 * @param cfg configuration
315 run (void *cls, char *const *args, const char *cfgfile,
316 const struct GNUNET_CONFIGURATION_Handle *cfg)
318 set_value = GNUNET_NO;
321 if (1 != SSCANF (args[0], "%llu", &set_val))
323 FPRINTF (stderr, _("Invalid argument `%s'\n"), args[0]);
327 set_value = GNUNET_YES;
329 if (NULL != remote_host)
330 GNUNET_CLIENT_service_test ("resolver", cfg, GNUNET_TIME_UNIT_SECONDS,
331 &resolver_test_task, (void *) cfg);
333 GNUNET_SCHEDULER_add_now (&main_task, (void *) cfg);
338 * The main function to obtain statistics in GNUnet.
340 * @param argc number of arguments from the command line
341 * @param argv command line arguments
342 * @return 0 ok, 1 on error
345 main (int argc, char *const *argv)
347 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
348 {'n', "name", "NAME",
349 gettext_noop ("limit output to statistics for the given NAME"), 1,
350 &GNUNET_GETOPT_set_string, &name},
351 {'p', "persistent", NULL,
352 gettext_noop ("make the value being set persistent"), 0,
353 &GNUNET_GETOPT_set_one, &persistent},
354 {'s', "subsystem", "SUBSYSTEM",
355 gettext_noop ("limit output to the given SUBSYSTEM"), 1,
356 &GNUNET_GETOPT_set_string, &subsystem},
358 gettext_noop ("just print the statistics value"), 0,
359 &GNUNET_GETOPT_set_one, &quiet},
361 gettext_noop ("watch value continuously"), 0,
362 &GNUNET_GETOPT_set_one, &watch},
363 {'r', "remote", NULL,
364 gettext_noop ("connect to remote host"), 1,
365 &GNUNET_GETOPT_set_string, &remote_host},
367 gettext_noop ("port for remote host"), 1,
368 &GNUNET_GETOPT_set_uint, &remote_port},
369 GNUNET_GETOPT_OPTION_END
373 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
377 GNUNET_PROGRAM_run (argc, argv, "gnunet-statistics [options [value]]",
379 ("Print statistics about GNUnet operations."),
380 options, &run, NULL)) ? ret : 1;
381 GNUNET_free_non_null (remote_host);
382 GNUNET_free ((void*) argv);
386 /* end of gnunet-statistics.c */