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 3, 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, 1)
  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, const char *subsystem, const char *name, uint64_t value,
  67          int is_persistent)
  68 {
  69   FPRINTF (stdout, "%s%-12s %-50s: %16llu\n", is_persistent ? "!" : " ",
  70            subsystem, _(name), (unsigned long long) value);
  71   return GNUNET_OK;
  72 }
  73
  74
  75 /**
  76  * Function called last by the statistics code.
  77  *
  78  * @param cls closure
  79  * @param success GNUNET_OK if statistics were
  80  *        successfully obtained, GNUNET_SYSERR if not.
  81  */
  82 static void
  83 cleanup (void *cls, int success)
  84 {
  85   struct GNUNET_STATISTICS_Handle *h = cls;
  86
  87   if (success != GNUNET_OK)
  88   {
  89     fprintf (stderr, _("Failed to obtain statistics.\n"));
  90     ret = 1;
  91   }
  92   if (h != NULL)
  93     GNUNET_STATISTICS_destroy (h, GNUNET_NO);
  94 }
  95
  96
  97 /**
  98  * Main function that will be run by the scheduler.
  99  *
 100  * @param cls closure
 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, char *const *args, const char *cfgfile,
 107      const struct GNUNET_CONFIGURATION_Handle *cfg)
 108 {
 109   struct GNUNET_STATISTICS_Handle *h;
 110   unsigned long long val;
 111
 112   if (args[0] != NULL)
 113   {
 114     if ((1 != SSCANF (args[0], "%llu", &val)) || (subsystem == NULL) ||
 115         (name == NULL))
 116     {
 117       FPRINTF (stderr, _("Invalid argument `%s'\n"), args[0]);
 118       ret = 1;
 119       return;
 120     }
 121     h = GNUNET_STATISTICS_create (subsystem, cfg);
 122     if (h == NULL)
 123     {
 124       ret = 1;
 125       return;
 126     }
 127     GNUNET_STATISTICS_set (h, name, (uint64_t) val, persistent);
 128     GNUNET_STATISTICS_destroy (h, GNUNET_YES);
 129     return;
 130   }
 131   h = GNUNET_STATISTICS_create ("gnunet-statistics", cfg);
 132   if (h == NULL)
 133   {
 134     ret = 1;
 135     return;
 136   }
 137   if (NULL ==
 138       GNUNET_STATISTICS_get (h, subsystem, name, GET_TIMEOUT, &cleanup,
 139                              &printer, h))
 140     cleanup (h, GNUNET_SYSERR);
 141 }
 142
 143 /**
 144  * The main function to obtain statistics in GNUnet.
 145  *
 146  * @param argc number of arguments from the command line
 147  * @param argv command line arguments
 148  * @return 0 ok, 1 on error
 149  */
 150 int
 151 main (int argc, char *const *argv)
 152 {
 153   static const struct GNUNET_GETOPT_CommandLineOption options[] = {
 154     {'n', "name", "NAME",
 155      gettext_noop ("limit output to statistcs for the given NAME"), 1,
 156      &GNUNET_GETOPT_set_string, &name},
 157     {'p', "persistent", NULL,
 158      gettext_noop ("make the value being set persistent"), 0,
 159      &GNUNET_GETOPT_set_one, &persistent},
 160     {'s', "subsystem", "SUBSYSTEM",
 161      gettext_noop ("limit output to the given SUBSYSTEM"), 1,
 162      &GNUNET_GETOPT_set_string, &subsystem},
 163     GNUNET_GETOPT_OPTION_END
 164   };
 165   return (GNUNET_OK ==
 166           GNUNET_PROGRAM_run (argc, argv, "gnunet-statistics [options [value]]",
 167                               gettext_noop
 168                               ("Print statistics about GNUnet operations."),
 169                               options, &run, NULL)) ? ret : 1;
 170 }
 171
 172 /* end of gnunet-statistics.c */