src/statistics/gnunet-statistics.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001, 2002, 2004, 2005, 2006, 2007, 2009 Christian Grothoff (and other contributing authors)
   4
   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 2, or (at your
   8      option) any later version.
   9
  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.
  14
  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.
  19 */
  20
  21 /**
  22  * @file statistics/gnunet-statistics.c
  23  * @brief tool to obtain statistics
  24  * @author Christian Grothoff
  25  * @author Igor Wronsky
  26  */
  27 #include "platform.h"
  28 #include "gnunet_getopt_lib.h"
  29 #include "gnunet_program_lib.h"
  30 #include "gnunet_statistics_service.h"
  31 #include "statistics.h"
  32
  33 #define GET_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 15)
  34
  35 /**
  36  * Final status code.
  37  */
  38 static int ret;
  39
  40 /**
  41  * Set to subsystem that we're going to get stats for (or NULL for all).
  42  */
  43 static char *subsystem;
  44
  45 /**
  46  * Set to the specific stat value that we are after (or NULL for all).
  47  */
  48 static char *name;
  49
  50 /**
  51  * Make the value that is being set persistent.
  52  */
  53 static int persistent;
  54
  55 /**
  56  * Callback function to process statistic values.
  57  *
  58  * @param cls closure
  59  * @param subsystem name of subsystem that created the statistic
  60  * @param name the name of the datum
  61  * @param value the current value
  62  * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
  63  * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
  64  */
  65 static int
  66 printer (void *cls,
  67          const char *subsystem,
  68          const char *sname, unsigned long long value, int is_persistent)
  69 {
  70   FPRINTF (stdout,
  71            "%s%-20s %-40s: %16llu\n",
  72            is_persistent ? "!" : " ", subsystem, _(sname), value);
  73   return GNUNET_OK;
  74 }
  75
  76
  77 /**
  78  * Function called last by the statistics code.
  79  *
  80  * @param cls closure
  81  * @param success GNUNET_OK if statistics were
  82  *        successfully obtained, GNUNET_SYSERR if not.
  83  */
  84 static void
  85 cleanup (void *cls, int success)
  86 {
  87   struct GNUNET_STATISTICS_Handle *h = cls;
  88
  89   if (success != GNUNET_OK)
  90     ret = 1;
  91   if (h != NULL)
  92     GNUNET_STATISTICS_destroy (h);
  93 }
  94
  95
  96 /**
  97  * Main function that will be run by the scheduler.
  98  *
  99  * @param cls closure
 100  * @param sched the scheduler to use
 101  * @param args remaining command-line arguments
 102  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
 103  * @param cfg configuration
 104  */
 105 static void
 106 run (void *cls,
 107      struct GNUNET_SCHEDULER_Handle *sched,
 108      char *const *args,
 109      const char *cfgfile,
 110      const struct GNUNET_CONFIGURATION_Handle *cfg)
 111 {
 112   struct GNUNET_STATISTICS_Handle *h;
 113   unsigned long long val;
 114
 115   if (args[0] != NULL)
 116     {
 117       if ((1 != SSCANF (args[0], "%llu", &val)) ||
 118           (subsystem == NULL) || (name == NULL))
 119         {
 120           FPRINTF (stderr, _("Invalid argument `%s'\n"), args[0]);
 121           ret = 1;
 122           return;
 123         }
 124       h = GNUNET_STATISTICS_create (sched, subsystem, cfg);
 125       if (h == NULL)
 126         {
 127           ret = 1;
 128           return;
 129         }
 130       GNUNET_STATISTICS_set (h, name, val, persistent);
 131       GNUNET_STATISTICS_destroy (h);
 132       return;
 133     }
 134   h = GNUNET_STATISTICS_create (sched, "gnunet-statistics", cfg);
 135   if (h == NULL)
 136     {
 137       ret = 1;
 138       return;
 139     }
 140   GNUNET_STATISTICS_get (h,
 141                          subsystem, name, GET_TIMEOUT, &cleanup, &printer, h);
 142 }
 143
 144 /**
 145  * gnunet-statistics command line options
 146  */
 147 static struct GNUNET_GETOPT_CommandLineOption options[] = {
 148   {'n', "name", "NAME",
 149    gettext_noop ("limit output to statistcs for the given NAME"), 1,
 150    &GNUNET_GETOPT_set_string, &name},
 151   {'p', "persistent", NULL,
 152    gettext_noop ("make the value being set persistent"), 0,
 153    &GNUNET_GETOPT_set_one, &persistent},
 154   {'s', "subsystem", "SUBSYSTEM",
 155    gettext_noop ("limit output to the given SUBSYSTEM"), 1,
 156    &GNUNET_GETOPT_set_string, &subsystem},
 157   GNUNET_GETOPT_OPTION_END
 158 };
 159
 160
 161 /**
 162  * The main function to obtain statistics in GNUnet.
 163  *
 164  * @param argc number of arguments from the command line
 165  * @param argv command line arguments
 166  * @return 0 ok, 1 on error
 167  */
 168 int
 169 main (int argc, char *const *argv)
 170 {
 171   return (GNUNET_OK ==
 172           GNUNET_PROGRAM_run (argc,
 173                               argv,
 174                               "gnunet-statistics",
 175                               gettext_noop
 176                               ("Print statistics about GNUnet operations."),
 177                               options, &run, NULL)) ? ret : 1;
 178 }
 179
 180 /* end of gnunet-statistics.c */