src/dht/gnunet-dht-monitor.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2012 GNUnet e.V.
   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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20 /**
  21  * @file dht/gnunet-dht-monitor.c
  22  * @brief search for data in DHT
  23  * @author Christian Grothoff
  24  * @author Bartlomiej Polot
  25  */
  26 #include "platform.h"
  27 #include "gnunet_dht_service.h"
  28
  29 /**
  30  * The type of the query
  31  */
  32 static unsigned int block_type;
  33
  34 /**
  35  * The key to be monitored
  36  */
  37 static char *query_key;
  38
  39 /**
  40  * User supplied timeout value (in seconds)
  41  */
  42 static struct GNUNET_TIME_Relative timeout_request = { 60000 };
  43
  44 /**
  45  * Be verbose
  46  */
  47 static int verbose;
  48
  49 /**
  50 * Handle to the DHT
  51  */
  52 static struct GNUNET_DHT_Handle *dht_handle;
  53
  54 /**
  55  * Global handle of the configuration
  56  */
  57 static const struct GNUNET_CONFIGURATION_Handle *cfg;
  58
  59 /**
  60  * Handle for the get request
  61  */
  62 static struct GNUNET_DHT_MonitorHandle *monitor_handle;
  63
  64 /**
  65  * Count of messages received
  66  */
  67 static unsigned int result_count;
  68
  69 /**
  70  * Global status value
  71  */
  72 static int ret;
  73
  74 /**
  75  * Task scheduled to handle timeout.
  76  */
  77 static struct GNUNET_SCHEDULER_Task *tt;
  78
  79
  80 /**
  81  * Stop monitoring request and start shutdown
  82  *
  83  * @param cls closure (unused)
  84  */
  85 static void
  86 cleanup_task (void *cls)
  87 {
  88   if (verbose)
  89     FPRINTF (stderr, "%s",  "Cleaning up!\n");
  90   if (NULL != monitor_handle)
  91   {
  92     GNUNET_DHT_monitor_stop (monitor_handle);
  93     monitor_handle = NULL;
  94   }
  95   if (NULL != dht_handle)
  96   {
  97     GNUNET_DHT_disconnect (dht_handle);
  98     dht_handle = NULL;
  99   }
 100   if (NULL != tt)
 101   {
 102     GNUNET_SCHEDULER_cancel (tt);
 103     tt = NULL;
 104   }
 105 }
 106
 107
 108 /**
 109  * We hit a timeout. Stop monitoring request and start shutdown
 110  *
 111  * @param cls closure (unused)
 112  */
 113 static void
 114 timeout_task (void *cls)
 115 {
 116   tt = NULL;
 117   GNUNET_SCHEDULER_shutdown ();
 118 }
 119
 120
 121
 122 /**
 123  * Callback called on each GET request going through the DHT.
 124  *
 125  * @param cls Closure.
 126  * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
 127  * @param type The type of data in the request.
 128  * @param hop_count Hop count so far.
 129  * @param path_length number of entries in path (or 0 if not recorded).
 130  * @param path peers on the GET path (or NULL if not recorded).
 131  * @param desired_replication_level Desired replication level.
 132  * @param key Key of the requested data.
 133  */
 134 static void
 135 get_callback (void *cls,
 136               enum GNUNET_DHT_RouteOption options,
 137               enum GNUNET_BLOCK_Type type,
 138               uint32_t hop_count,
 139               uint32_t desired_replication_level,
 140               unsigned int path_length,
 141               const struct GNUNET_PeerIdentity *path,
 142               const struct GNUNET_HashCode * key)
 143 {
 144   FPRINTF (stdout, "GET #%u: type %d, key `%s'\n",
 145            result_count,
 146            (int) type,
 147            GNUNET_h2s_full(key));
 148   result_count++;
 149 }
 150
 151
 152 /**
 153  * Callback called on each GET reply going through the DHT.
 154  *
 155  * @param cls Closure.
 156  * @param type The type of data in the result.
 157  * @param get_path Peers on GET path (or NULL if not recorded).
 158  * @param get_path_length number of entries in get_path.
 159  * @param put_path peers on the PUT path (or NULL if not recorded).
 160  * @param put_path_length number of entries in get_path.
 161  * @param exp Expiration time of the data.
 162  * @param key Key of the data.
 163  * @param data Pointer to the result data.
 164  * @param size Number of bytes in data.
 165  */
 166 static void
 167 get_resp_callback (void *cls,
 168                    enum GNUNET_BLOCK_Type type,
 169                    const struct GNUNET_PeerIdentity *get_path,
 170                    unsigned int get_path_length,
 171                    const struct GNUNET_PeerIdentity *put_path,
 172                    unsigned int put_path_length,
 173                    struct GNUNET_TIME_Absolute exp,
 174                    const struct GNUNET_HashCode * key,
 175                    const void *data,
 176                    size_t size)
 177 {
 178   FPRINTF (stdout,
 179            "RESPONSE #%u: type %d, key `%s', data `%.*s'\n",
 180            result_count,
 181            (int) type,
 182            GNUNET_h2s_full (key),
 183            (unsigned int) size,
 184            (char *) data);
 185   result_count++;
 186 }
 187
 188
 189 /**
 190  * Callback called on each PUT request going through the DHT.
 191  *
 192  * @param cls Closure.
 193  * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
 194  * @param type The type of data in the request.
 195  * @param hop_count Hop count so far.
 196  * @param path_length number of entries in path (or 0 if not recorded).
 197  * @param path peers on the PUT path (or NULL if not recorded).
 198  * @param desired_replication_level Desired replication level.
 199  * @param exp Expiration time of the data.
 200  * @param key Key under which data is to be stored.
 201  * @param data Pointer to the data carried.
 202  * @param size Number of bytes in data.
 203  */
 204 static void
 205 put_callback (void *cls,
 206               enum GNUNET_DHT_RouteOption options,
 207               enum GNUNET_BLOCK_Type type,
 208               uint32_t hop_count,
 209               uint32_t desired_replication_level,
 210               unsigned int path_length,
 211               const struct GNUNET_PeerIdentity *path,
 212               struct GNUNET_TIME_Absolute exp,
 213               const struct GNUNET_HashCode * key,
 214               const void *data,
 215               size_t size)
 216 {
 217   FPRINTF (stdout,
 218            "PUT %u: type %d, key `%s', data `%.*s'\n",
 219            result_count,
 220            (int) type,
 221            GNUNET_h2s_full(key),
 222            (unsigned int) size,
 223            (char *) data);
 224   result_count++;
 225 }
 226
 227
 228 /**
 229  * Main function that will be run by the scheduler.
 230  *
 231  * @param cls closure
 232  * @param args remaining command-line arguments
 233  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
 234  * @param c configuration
 235  */
 236 static void
 237 run (void *cls, char *const *args, const char *cfgfile,
 238      const struct GNUNET_CONFIGURATION_Handle *c)
 239 {
 240   struct GNUNET_HashCode *key;
 241   struct GNUNET_HashCode hc;
 242
 243   cfg = c;
 244
 245   if (NULL == (dht_handle = GNUNET_DHT_connect (cfg, 1)))
 246   {
 247     FPRINTF (stderr, "%s",
 248              _("Failed to connect to DHT service!\n"));
 249     ret = 1;
 250     return;
 251   }
 252   if (GNUNET_BLOCK_TYPE_ANY == block_type)      /* Type of data not set */
 253     block_type = GNUNET_BLOCK_TYPE_TEST;
 254   if (NULL != query_key)
 255     {
 256       key = &hc;
 257       if (GNUNET_OK !=
 258           GNUNET_CRYPTO_hash_from_string (query_key, key))
 259         GNUNET_CRYPTO_hash (query_key, strlen (query_key), key);
 260     }
 261   else
 262     {
 263       key = NULL;
 264     }
 265   if (verbose)
 266     FPRINTF (stderr,
 267              "Monitoring for %s\n",
 268              GNUNET_STRINGS_relative_time_to_string (timeout_request, GNUNET_NO));
 269   tt = GNUNET_SCHEDULER_add_delayed (timeout_request,
 270                                      &timeout_task,
 271                                      NULL);
 272   GNUNET_SCHEDULER_add_shutdown (&cleanup_task,
 273                                 NULL);
 274   monitor_handle = GNUNET_DHT_monitor_start (dht_handle,
 275                                              block_type,
 276                                              key,
 277                                              &get_callback,
 278                                              &get_resp_callback,
 279                                              &put_callback,
 280                                              NULL);
 281 }
 282
 283
 284 /**
 285  * gnunet-dht-monitor command line options
 286  */
 287 static struct GNUNET_GETOPT_CommandLineOption options[] = {
 288   {'k', "key", "KEY",
 289    gettext_noop ("the query key"),
 290    1, &GNUNET_GETOPT_set_string, &query_key},
 291   {'t', "type", "TYPE",
 292    gettext_noop ("the type of data to look for"),
 293    1, &GNUNET_GETOPT_set_uint, &block_type},
 294   {'T', "timeout", "TIMEOUT",
 295    gettext_noop ("how long should the monitor command run"),
 296    1, &GNUNET_GETOPT_set_relative_time, &timeout_request},
 297   {'V', "verbose", NULL,
 298    gettext_noop ("be verbose (print progress information)"),
 299    0, &GNUNET_GETOPT_set_one, &verbose},
 300   GNUNET_GETOPT_OPTION_END
 301 };
 302
 303
 304 /**
 305  * Entry point for gnunet-dht-monitor
 306  *
 307  * @param argc number of arguments from the command line
 308  * @param argv command line arguments
 309  * @return 0 ok, 1 on error
 310  */
 311 int
 312 main (int argc, char *const *argv)
 313 {
 314   if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
 315     return 2;
 316
 317   return (GNUNET_OK ==
 318           GNUNET_PROGRAM_run (argc, argv, "gnunet-dht-monitor",
 319                               gettext_noop
 320                               ("Prints all packets that go through the DHT."),
 321                               options, &run, NULL)) ? ret : 1;
 322 }
 323
 324 /* end of gnunet-dht-monitor.c */