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_util_lib.h"
  31 #include "gnunet_statistics_service.h"
  32 #include "statistics.h"
  33
  34 #define GET_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
  35
  36 /**
  37  * Final status code.
  38  */
  39 static int ret;
  40
  41 /**
  42  * Set to subsystem that we're going to get stats for (or NULL for all).
  43  */
  44 static char *subsystem;
  45
  46 /**
  47  * Set to the specific stat value that we are after (or NULL for all).
  48  */
  49 static char *name;
  50
  51 /**
  52  * Make the value that is being set persistent.
  53  */
  54 static int persistent;
  55
  56 /**
  57  * Watch value continuously
  58  */
  59 static int watch;
  60
  61 /**
  62  * Quiet mode
  63  */
  64 static int quiet;
  65
  66 /**
  67  * Remote host
  68  */
  69 static char *remote_host;
  70
  71 /**
  72  * Remote host's port
  73  */
  74 static unsigned long long  remote_port;
  75
  76 /**
  77  * Value to set
  78  */
  79 static unsigned long long set_val;
  80
  81 /**
  82  * Set operation
  83  */
  84 static int set_value;
  85
  86 /**
  87  * Callback function to process statistic values.
  88  *
  89  * @param cls closure
  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
  95  */
  96 static int
  97 printer (void *cls, const char *subsystem, const char *name, uint64_t value,
  98          int is_persistent)
  99 {
 100   struct GNUNET_TIME_Absolute now = GNUNET_TIME_absolute_get();
 101   const char * now_str;
 102
 103   if (quiet == GNUNET_NO)
 104   {
 105     if (GNUNET_YES == watch)
 106     {
 107       now_str = GNUNET_STRINGS_absolute_time_to_string(now);
 108       FPRINTF (stdout, "%24s %s%12s %50s: %16llu \n",
 109                now_str,
 110                is_persistent ? "!" : " ",
 111                subsystem, _(name), (unsigned long long) value);
 112     }
 113     else
 114     {
 115       FPRINTF (stdout, "%s%12s %50s: %16llu \n",
 116                is_persistent ? "!" : " ",
 117                subsystem, _(name), (unsigned long long) value);
 118     }
 119   }
 120   else
 121     FPRINTF (stdout, "%llu\n", (unsigned long long) value);
 122
 123   return GNUNET_OK;
 124 }
 125
 126
 127 /**
 128  * Function called last by the statistics code.
 129  *
 130  * @param cls closure
 131  * @param success GNUNET_OK if statistics were
 132  *        successfully obtained, GNUNET_SYSERR if not.
 133  */
 134 static void
 135 cleanup (void *cls, int success)
 136 {
 137
 138   if (success != GNUNET_OK)
 139   {
 140     if (NULL == remote_host)
 141       FPRINTF (stderr, "%s", _("Failed to obtain statistics.\n"));
 142     else
 143       FPRINTF (stderr,  _("Failed to obtain statistics from host `%s:%llu'\n"),
 144               remote_host, remote_port);
 145     ret = 1;
 146   }
 147   GNUNET_SCHEDULER_shutdown ();
 148 }
 149
 150
 151 /**
 152  * Function run on shutdown to clean up.
 153  *
 154  * @param cls the statistics handle
 155  * @param tc scheduler context
 156  */
 157 static void
 158 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 159 {
 160   struct GNUNET_STATISTICS_Handle *h = cls;
 161
 162   if (NULL == h)
 163     return;
 164   GNUNET_STATISTICS_watch_cancel (h, subsystem, name, &printer, h);
 165   GNUNET_STATISTICS_destroy (h, GNUNET_NO);
 166   h = NULL;
 167 }
 168
 169
 170
 171 static void
 172 resolver_test_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 173 {
 174   struct GNUNET_CONFIGURATION_Handle *cfg = cls;
 175   struct GNUNET_STATISTICS_Handle *h;
 176
 177   if (NULL != remote_host)
 178   {
 179       if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_TIMEOUT))
 180       {
 181           FPRINTF (stderr, _("Trying to connect to remote host, but service `%s' is not running\n"), "resolver");
 182           return;
 183       }
 184
 185       /* connect to a remote host */
 186       if (0 == remote_port)
 187       {
 188         if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_number (cfg, "statistics", "PORT", &remote_port))
 189         {
 190           FPRINTF (stderr, _("A port is required to connect to host `%s'\n"), remote_host);
 191           return;
 192         }
 193       }
 194       else if (65535 <= remote_port)
 195       {
 196           FPRINTF (stderr, _("A port has to be between 1 and 65535 to connect to host `%s'\n"), remote_host);
 197           return;
 198       }
 199
 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);
 204   }
 205
 206   if (set_value)
 207   {
 208     if (subsystem == NULL)
 209     {
 210       FPRINTF (stderr, "%s", _("Missing argument: subsystem \n"));
 211       ret = 1;
 212       return;
 213     }
 214     if (name == NULL)
 215     {
 216       FPRINTF (stderr, "%s", _("Missing argument: name\n"));
 217       ret = 1;
 218       return;
 219     }
 220     h = GNUNET_STATISTICS_create (subsystem, cfg);
 221     if (NULL == h)
 222     {
 223       ret = 1;
 224       return;
 225     }
 226     GNUNET_STATISTICS_set (h, name, (uint64_t) set_val, persistent);
 227     GNUNET_STATISTICS_destroy (h, GNUNET_YES);
 228     h = NULL;
 229     return;
 230   }
 231   if (NULL == (h = GNUNET_STATISTICS_create ("gnunet-statistics", cfg)))
 232   {
 233     ret = 1;
 234     return;
 235   }
 236   if (GNUNET_NO == watch)
 237   {
 238     if (NULL ==
 239       GNUNET_STATISTICS_get (h, subsystem, name, GET_TIMEOUT, &cleanup,
 240                              &printer, h))
 241     cleanup (h, GNUNET_SYSERR);
 242   }
 243   else
 244   {
 245     if ((NULL == subsystem) || (NULL == name))
 246     {
 247       printf (_("No subsystem or name given\n"));
 248       GNUNET_STATISTICS_destroy (h, GNUNET_NO);
 249       h = NULL;
 250       ret = 1;
 251       return;
 252     }
 253     if (GNUNET_OK != GNUNET_STATISTICS_watch (h, subsystem, name, &printer, h))
 254     {
 255       fprintf (stderr, _("Failed to initialize watch routine\n"));
 256       GNUNET_SCHEDULER_add_now (&shutdown_task, h);
 257       return;
 258     }
 259   }
 260   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
 261                                 &shutdown_task, h);
 262
 263 }
 264
 265
 266 /**
 267  * Main function that will be run by the scheduler.
 268  *
 269  * @param cls closure
 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
 273  */
 274 static void
 275 run (void *cls, char *const *args, const char *cfgfile,
 276      const struct GNUNET_CONFIGURATION_Handle *cfg)
 277 {
 278   set_value = GNUNET_NO;
 279   if (NULL != args[0])
 280   {
 281       if (1 != SSCANF (args[0], "%llu", &set_val))
 282       {
 283           FPRINTF (stderr, _("Invalid argument `%s'\n"), args[0]);
 284           ret = 1;
 285           return;
 286       }
 287       set_value = GNUNET_YES;
 288   }
 289
 290   if (NULL != remote_host)
 291       GNUNET_CLIENT_service_test ("resolver", cfg, GNUNET_TIME_UNIT_SECONDS, &resolver_test_task, (void *) cfg);
 292   else
 293       GNUNET_SCHEDULER_add_now (&resolver_test_task, (void *) cfg);
 294
 295 }
 296
 297
 298 /**
 299  * The main function to obtain statistics in GNUnet.
 300  *
 301  * @param argc number of arguments from the command line
 302  * @param argv command line arguments
 303  * @return 0 ok, 1 on error
 304  */
 305 int
 306 main (int argc, char *const *argv)
 307 {
 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},
 318     {'q', "quiet", NULL,
 319      gettext_noop ("just print the statistics value"), 0,
 320      &GNUNET_GETOPT_set_one, &quiet},
 321     {'w', "watch", NULL,
 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},
 327     {'o', "port", NULL,
 328      gettext_noop ("port for remote host"), 1,
 329      &GNUNET_GETOPT_set_uint, &remote_port},
 330     GNUNET_GETOPT_OPTION_END
 331   };
 332   remote_port = 0;
 333   remote_host = NULL;
 334   if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
 335     return 2;
 336
 337   ret = (GNUNET_OK ==
 338          GNUNET_PROGRAM_run (argc, argv, "gnunet-statistics [options [value]]",
 339                              gettext_noop
 340                              ("Print statistics about GNUnet operations."),
 341                              options, &run, NULL)) ? ret : 1;
 342   GNUNET_free_non_null (remote_host);
 343   GNUNET_free ((void*) argv);
 344   return ret;
 345 }
 346
 347 /* end of gnunet-statistics.c */