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 it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your 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      Affero General Public License for more details.
  14
  15      You should have received a copy of the GNU Affero General Public License
  16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18      SPDX-License-Identifier: AGPL3.0-or-later
  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  * Callback called on each GET request going through the DHT.
 123  *
 124  * @param cls Closure.
 125  * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
 126  * @param type The type of data in the request.
 127  * @param hop_count Hop count so far.
 128  * @param path_length number of entries in path (or 0 if not recorded).
 129  * @param path peers on the GET path (or NULL if not recorded).
 130  * @param desired_replication_level Desired replication level.
 131  * @param key Key of the requested data.
 132  */
 133 static void
 134 get_callback (void *cls,
 135               enum GNUNET_DHT_RouteOption options,
 136               enum GNUNET_BLOCK_Type type,
 137               uint32_t hop_count,
 138               uint32_t desired_replication_level,
 139               unsigned int path_length,
 140               const struct GNUNET_PeerIdentity *path,
 141               const struct GNUNET_HashCode *key)
 142 {
 143   fprintf (stdout,
 144            "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            (GNUNET_BLOCK_TYPE_TEST == type)
 180              ? "RESPONSE #%u (%s): type %d, key `%s', data `%.*s'\n"
 181              : "RESPONSE #%u (%s): type %d, key `%s'\n",
 182            result_count,
 183            GNUNET_STRINGS_absolute_time_to_string (exp),
 184            (int) type,
 185            GNUNET_h2s_full (key),
 186            (unsigned int) size,
 187            (char *) data);
 188   result_count++;
 189 }
 190
 191
 192 /**
 193  * Callback called on each PUT request going through the DHT.
 194  *
 195  * @param cls Closure.
 196  * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
 197  * @param type The type of data in the request.
 198  * @param hop_count Hop count so far.
 199  * @param path_length number of entries in path (or 0 if not recorded).
 200  * @param path peers on the PUT path (or NULL if not recorded).
 201  * @param desired_replication_level Desired replication level.
 202  * @param exp Expiration time of the data.
 203  * @param key Key under which data is to be stored.
 204  * @param data Pointer to the data carried.
 205  * @param size Number of bytes in data.
 206  */
 207 static void
 208 put_callback (void *cls,
 209               enum GNUNET_DHT_RouteOption options,
 210               enum GNUNET_BLOCK_Type type,
 211               uint32_t hop_count,
 212               uint32_t desired_replication_level,
 213               unsigned int path_length,
 214               const struct GNUNET_PeerIdentity *path,
 215               struct GNUNET_TIME_Absolute exp,
 216               const struct GNUNET_HashCode *key,
 217               const void *data,
 218               size_t size)
 219 {
 220   fprintf (stdout,
 221            (GNUNET_BLOCK_TYPE_TEST == type)
 222              ? "PUT %u (%s): type %d, key `%s', data `%.*s'\n"
 223              : "PUT %u (%s): type %d, key `%s'\n",
 224            result_count,
 225            GNUNET_STRINGS_absolute_time_to_string (exp),
 226            (int) type,
 227            GNUNET_h2s_full (key),
 228            (unsigned int) size,
 229            (char *) data);
 230   result_count++;
 231 }
 232
 233
 234 /**
 235  * Main function that will be run by the scheduler.
 236  *
 237  * @param cls closure
 238  * @param args remaining command-line arguments
 239  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
 240  * @param c configuration
 241  */
 242 static void
 243 run (void *cls,
 244      char *const *args,
 245      const char *cfgfile,
 246      const struct GNUNET_CONFIGURATION_Handle *c)
 247 {
 248   struct GNUNET_HashCode *key;
 249   struct GNUNET_HashCode hc;
 250
 251   cfg = c;
 252
 253   if (NULL == (dht_handle = GNUNET_DHT_connect (cfg, 1)))
 254   {
 255     fprintf (stderr, "%s", _ ("Failed to connect to DHT service!\n"));
 256     ret = 1;
 257     return;
 258   }
 259   if (GNUNET_BLOCK_TYPE_ANY == block_type) /* Type of data not set */
 260     block_type = GNUNET_BLOCK_TYPE_TEST;
 261   if (NULL != query_key)
 262   {
 263     key = &hc;
 264     if (GNUNET_OK != GNUNET_CRYPTO_hash_from_string (query_key, key))
 265       GNUNET_CRYPTO_hash (query_key, strlen (query_key), key);
 266   }
 267   else
 268   {
 269     key = NULL;
 270   }
 271   if (verbose)
 272     fprintf (stderr,
 273              "Monitoring for %s\n",
 274              GNUNET_STRINGS_relative_time_to_string (timeout_request,
 275                                                      GNUNET_NO));
 276   tt = GNUNET_SCHEDULER_add_delayed (timeout_request, &timeout_task, NULL);
 277   GNUNET_SCHEDULER_add_shutdown (&cleanup_task, NULL);
 278   monitor_handle = GNUNET_DHT_monitor_start (dht_handle,
 279                                              block_type,
 280                                              key,
 281                                              &get_callback,
 282                                              &get_resp_callback,
 283                                              &put_callback,
 284                                              NULL);
 285 }
 286
 287 /**
 288  * Entry point for gnunet-dht-monitor
 289  *
 290  * @param argc number of arguments from the command line
 291  * @param argv command line arguments
 292  * @return 0 ok, 1 on error
 293  */
 294 int
 295 main (int argc, char *const *argv)
 296 {
 297   struct GNUNET_GETOPT_CommandLineOption options[] = {
 298
 299     GNUNET_GETOPT_option_string ('k',
 300                                  "key",
 301                                  "KEY",
 302                                  gettext_noop ("the query key"),
 303                                  &query_key),
 304
 305     GNUNET_GETOPT_option_uint ('t',
 306                                "type",
 307                                "TYPE",
 308                                gettext_noop ("the type of data to look for"),
 309                                &block_type),
 310
 311     GNUNET_GETOPT_option_relative_time (
 312       'T',
 313       "timeout",
 314       "TIMEOUT",
 315       gettext_noop ("how long should the monitor command run"),
 316       &timeout_request),
 317
 318     GNUNET_GETOPT_option_flag ('V',
 319                                "verbose",
 320                                gettext_noop (
 321                                  "be verbose (print progress information)"),
 322                                &verbose),
 323
 324     GNUNET_GETOPT_OPTION_END};
 325
 326
 327   if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
 328     return 2;
 329
 330   return (GNUNET_OK ==
 331           GNUNET_PROGRAM_run (argc,
 332                               argv,
 333                               "gnunet-dht-monitor",
 334                               gettext_noop (
 335                                 "Prints all packets that go through the DHT."),
 336                               options,
 337                               &run,
 338                               NULL))
 339            ? ret
 340            : 1;
 341 }
 342
 343 /* end of gnunet-dht-monitor.c */