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_getopt_lib.h"
29 #include "gnunet_program_lib.h"
30 #include "gnunet_util_lib.h"
31 #include "gnunet_statistics_service.h"
32 #include "statistics.h"
34 #define GET_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
42 * Set to subsystem that we're going to get stats for (or NULL for all).
44 static char *subsystem;
47 * Set to the specific stat value that we are after (or NULL for all).
52 * Make the value that is being set persistent.
54 static int persistent;
57 * Watch value continuously
69 static char *remote_host;
74 static unsigned long long remote_port;
79 static unsigned long long set_val;
87 * Callback function to process statistic values.
90 * @param subsystem name of subsystem that created the statistic
91 * @param name the name of the datum
92 * @param value the current value
93 * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
94 * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
97 printer (void *cls, const char *subsystem, const char *name, uint64_t value,
100 struct GNUNET_TIME_Absolute now = GNUNET_TIME_absolute_get();
101 const char * now_str;
103 if (quiet == GNUNET_NO)
105 if (GNUNET_YES == watch)
107 now_str = GNUNET_STRINGS_absolute_time_to_string(now);
108 FPRINTF (stdout, "%24s %s%12s %50s: %16llu \n",
110 is_persistent ? "!" : " ",
111 subsystem, _(name), (unsigned long long) value);
115 FPRINTF (stdout, "%s%12s %50s: %16llu \n",
116 is_persistent ? "!" : " ",
117 subsystem, _(name), (unsigned long long) value);
121 FPRINTF (stdout, "%llu\n", (unsigned long long) value);
128 * Function called last by the statistics code.
131 * @param success GNUNET_OK if statistics were
132 * successfully obtained, GNUNET_SYSERR if not.
135 cleanup (void *cls, int success)
138 if (success != GNUNET_OK)
140 if (NULL == remote_host)
141 FPRINTF (stderr, "%s", _("Failed to obtain statistics.\n"));
143 FPRINTF (stderr, _("Failed to obtain statistics from host `%s:%llu'\n"),
144 remote_host, remote_port);
147 GNUNET_SCHEDULER_shutdown ();
152 * Function run on shutdown to clean up.
154 * @param cls the statistics handle
155 * @param tc scheduler context
158 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
160 struct GNUNET_STATISTICS_Handle *h = cls;
164 GNUNET_STATISTICS_watch_cancel (h, subsystem, name, &printer, h);
165 GNUNET_STATISTICS_destroy (h, GNUNET_NO);
172 resolver_test_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
174 struct GNUNET_CONFIGURATION_Handle *cfg = cls;
175 struct GNUNET_STATISTICS_Handle *h;
177 if (NULL != remote_host)
179 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_TIMEOUT))
181 FPRINTF (stderr, _("Trying to connect to remote host, but service `%s' is not running\n"), "resolver");
185 /* connect to a remote host */
186 if (0 == remote_port)
188 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_number (cfg, "statistics", "PORT", &remote_port))
190 FPRINTF (stderr, _("A port is required to connect to host `%s'\n"), remote_host);
194 else if (65535 <= remote_port)
196 FPRINTF (stderr, _("A port has to be between 1 and 65535 to connect to host `%s'\n"), remote_host);
200 /* Manipulate configuration */
201 GNUNET_CONFIGURATION_set_value_string ((struct GNUNET_CONFIGURATION_Handle *) cfg, "statistics", "UNIXPATH", "");
202 GNUNET_CONFIGURATION_set_value_string ((struct GNUNET_CONFIGURATION_Handle *) cfg, "statistics", "HOSTNAME", remote_host);
203 GNUNET_CONFIGURATION_set_value_number ((struct GNUNET_CONFIGURATION_Handle *) cfg, "statistics", "PORT", remote_port);
208 if (subsystem == NULL)
210 FPRINTF (stderr, "%s", _("Missing argument: subsystem \n"));
216 FPRINTF (stderr, "%s", _("Missing argument: name\n"));
220 h = GNUNET_STATISTICS_create (subsystem, cfg);
226 GNUNET_STATISTICS_set (h, name, (uint64_t) set_val, persistent);
227 GNUNET_STATISTICS_destroy (h, GNUNET_YES);
231 if (NULL == (h = GNUNET_STATISTICS_create ("gnunet-statistics", cfg)))
236 if (GNUNET_NO == watch)
239 GNUNET_STATISTICS_get (h, subsystem, name, GET_TIMEOUT, &cleanup,
241 cleanup (h, GNUNET_SYSERR);
245 if ((NULL == subsystem) || (NULL == name))
247 printf (_("No subsystem or name given\n"));
248 GNUNET_STATISTICS_destroy (h, GNUNET_NO);
253 if (GNUNET_OK != GNUNET_STATISTICS_watch (h, subsystem, name, &printer, h))
255 fprintf (stderr, _("Failed to initialize watch routine\n"));
256 GNUNET_SCHEDULER_add_now (&shutdown_task, h);
260 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
267 * Main function that will be run by the scheduler.
270 * @param args remaining command-line arguments
271 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
272 * @param cfg configuration
275 run (void *cls, char *const *args, const char *cfgfile,
276 const struct GNUNET_CONFIGURATION_Handle *cfg)
278 set_value = GNUNET_NO;
281 if (1 != SSCANF (args[0], "%llu", &set_val))
283 FPRINTF (stderr, _("Invalid argument `%s'\n"), args[0]);
287 set_value = GNUNET_YES;
290 if (NULL != remote_host)
291 GNUNET_CLIENT_service_test ("resolver", cfg, GNUNET_TIME_UNIT_SECONDS, &resolver_test_task, (void *) cfg);
293 GNUNET_SCHEDULER_add_now (&resolver_test_task, (void *) cfg);
299 * The main function to obtain statistics in GNUnet.
301 * @param argc number of arguments from the command line
302 * @param argv command line arguments
303 * @return 0 ok, 1 on error
306 main (int argc, char *const *argv)
308 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
309 {'n', "name", "NAME",
310 gettext_noop ("limit output to statistics for the given NAME"), 1,
311 &GNUNET_GETOPT_set_string, &name},
312 {'p', "persistent", NULL,
313 gettext_noop ("make the value being set persistent"), 0,
314 &GNUNET_GETOPT_set_one, &persistent},
315 {'s', "subsystem", "SUBSYSTEM",
316 gettext_noop ("limit output to the given SUBSYSTEM"), 1,
317 &GNUNET_GETOPT_set_string, &subsystem},
319 gettext_noop ("just print the statistics value"), 0,
320 &GNUNET_GETOPT_set_one, &quiet},
322 gettext_noop ("watch value continuously"), 0,
323 &GNUNET_GETOPT_set_one, &watch},
324 {'r', "remote", NULL,
325 gettext_noop ("connect to remote host"), 1,
326 &GNUNET_GETOPT_set_string, &remote_host},
328 gettext_noop ("port for remote host"), 1,
329 &GNUNET_GETOPT_set_uint, &remote_port},
330 GNUNET_GETOPT_OPTION_END
334 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
338 GNUNET_PROGRAM_run (argc, argv, "gnunet-statistics [options [value]]",
340 ("Print statistics about GNUnet operations."),
341 options, &run, NULL)) ? ret : 1;
342 GNUNET_free_non_null (remote_host);
343 GNUNET_free ((void*) argv);
347 /* end of gnunet-statistics.c */