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 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
96 printer (void *cls, const char *subsystem, const char *name, uint64_t value,
99 struct GNUNET_TIME_Absolute now = GNUNET_TIME_absolute_get();
100 const char * now_str;
102 if (quiet == GNUNET_NO)
104 if (GNUNET_YES == watch)
106 now_str = GNUNET_STRINGS_absolute_time_to_string(now);
107 FPRINTF (stdout, "%24s %s%12s %50s: %16llu \n",
109 is_persistent ? "!" : " ",
110 subsystem, _(name), (unsigned long long) value);
114 FPRINTF (stdout, "%s%12s %50s: %16llu \n",
115 is_persistent ? "!" : " ",
116 subsystem, _(name), (unsigned long long) value);
120 FPRINTF (stdout, "%llu\n", (unsigned long long) value);
127 * Function called last by the statistics code.
130 * @param success #GNUNET_OK if statistics were
131 * successfully obtained, #GNUNET_SYSERR if not.
134 cleanup (void *cls, int success)
137 if (success != GNUNET_OK)
139 if (NULL == remote_host)
140 FPRINTF (stderr, "%s", _("Failed to obtain statistics.\n"));
142 FPRINTF (stderr, _("Failed to obtain statistics from host `%s:%llu'\n"),
143 remote_host, remote_port);
146 GNUNET_SCHEDULER_shutdown ();
151 * Function run on shutdown to clean up.
153 * @param cls the statistics handle
154 * @param tc scheduler context
157 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
159 struct GNUNET_STATISTICS_Handle *h = cls;
163 if ( (GNUNET_YES == watch) &&
164 (NULL != subsystem) &&
166 GNUNET_assert (GNUNET_OK ==
167 GNUNET_STATISTICS_watch_cancel (h, subsystem, name, &printer, h));
168 GNUNET_STATISTICS_destroy (h, GNUNET_NO);
174 * Main task that does the actual work.
176 * @param cls closure with our configuration
177 * @param tc schedueler context
180 main_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
182 const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
183 struct GNUNET_STATISTICS_Handle *h;
187 if (subsystem == NULL)
189 FPRINTF (stderr, "%s", _("Missing argument: subsystem \n"));
195 FPRINTF (stderr, "%s", _("Missing argument: name\n"));
199 h = GNUNET_STATISTICS_create (subsystem, cfg);
205 GNUNET_STATISTICS_set (h, name, (uint64_t) set_val, persistent);
206 GNUNET_STATISTICS_destroy (h, GNUNET_YES);
210 if (NULL == (h = GNUNET_STATISTICS_create ("gnunet-statistics", cfg)))
215 if (GNUNET_NO == watch)
218 GNUNET_STATISTICS_get (h, subsystem, name, GET_TIMEOUT, &cleanup,
220 cleanup (h, GNUNET_SYSERR);
224 if ((NULL == subsystem) || (NULL == name))
226 printf (_("No subsystem or name given\n"));
227 GNUNET_STATISTICS_destroy (h, GNUNET_NO);
232 if (GNUNET_OK != GNUNET_STATISTICS_watch (h, subsystem, name, &printer, h))
234 fprintf (stderr, _("Failed to initialize watch routine\n"));
235 GNUNET_SCHEDULER_add_now (&shutdown_task, h);
239 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
246 * Function called with th test result to see if the resolver is
249 * @param cls closure with our configuration
250 * @param result #GNUNET_YES if the resolver is running
253 resolver_test_task (void *cls,
256 struct GNUNET_CONFIGURATION_Handle *cfg = cls;
258 if (GNUNET_YES != result)
261 _("Trying to connect to remote host, but service `%s' is not running\n"), "resolver");
264 /* connect to a remote host */
265 if (0 == remote_port)
267 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_number (cfg, "statistics", "PORT", &remote_port))
269 FPRINTF (stderr, _("A port is required to connect to host `%s'\n"), remote_host);
273 else if (65535 <= remote_port)
276 _("A port has to be between 1 and 65535 to connect to host `%s'\n"), remote_host);
280 /* Manipulate configuration */
281 GNUNET_CONFIGURATION_set_value_string (cfg,
282 "statistics", "UNIXPATH", "");
283 GNUNET_CONFIGURATION_set_value_string (cfg,
284 "statistics", "HOSTNAME", remote_host);
285 GNUNET_CONFIGURATION_set_value_number (cfg,
286 "statistics", "PORT", remote_port);
287 GNUNET_SCHEDULER_add_now (&main_task, cfg);
292 * Main function that will be run by the scheduler.
295 * @param args remaining command-line arguments
296 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
297 * @param cfg configuration
300 run (void *cls, char *const *args, const char *cfgfile,
301 const struct GNUNET_CONFIGURATION_Handle *cfg)
303 set_value = GNUNET_NO;
306 if (1 != SSCANF (args[0], "%llu", &set_val))
308 FPRINTF (stderr, _("Invalid argument `%s'\n"), args[0]);
312 set_value = GNUNET_YES;
314 if (NULL != remote_host)
315 GNUNET_CLIENT_service_test ("resolver", cfg, GNUNET_TIME_UNIT_SECONDS,
316 &resolver_test_task, (void *) cfg);
318 GNUNET_SCHEDULER_add_now (&main_task, (void *) cfg);
323 * The main function to obtain statistics in GNUnet.
325 * @param argc number of arguments from the command line
326 * @param argv command line arguments
327 * @return 0 ok, 1 on error
330 main (int argc, char *const *argv)
332 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
333 {'n', "name", "NAME",
334 gettext_noop ("limit output to statistics for the given NAME"), 1,
335 &GNUNET_GETOPT_set_string, &name},
336 {'p', "persistent", NULL,
337 gettext_noop ("make the value being set persistent"), 0,
338 &GNUNET_GETOPT_set_one, &persistent},
339 {'s', "subsystem", "SUBSYSTEM",
340 gettext_noop ("limit output to the given SUBSYSTEM"), 1,
341 &GNUNET_GETOPT_set_string, &subsystem},
343 gettext_noop ("just print the statistics value"), 0,
344 &GNUNET_GETOPT_set_one, &quiet},
346 gettext_noop ("watch value continuously"), 0,
347 &GNUNET_GETOPT_set_one, &watch},
348 {'r', "remote", NULL,
349 gettext_noop ("connect to remote host"), 1,
350 &GNUNET_GETOPT_set_string, &remote_host},
352 gettext_noop ("port for remote host"), 1,
353 &GNUNET_GETOPT_set_uint, &remote_port},
354 GNUNET_GETOPT_OPTION_END
358 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
362 GNUNET_PROGRAM_run (argc, argv, "gnunet-statistics [options [value]]",
364 ("Print statistics about GNUnet operations."),
365 options, &run, NULL)) ? ret : 1;
366 GNUNET_free_non_null (remote_host);
367 GNUNET_free ((void*) argv);
371 /* end of gnunet-statistics.c */