GNUnet  0.10.x
gnunet-dht-monitor.c
Go to the documentation of this file.
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  */
26 #include "platform.h"
27 #include "gnunet_dht_service.h"
28 
32 static unsigned int block_type;
33 
37 static char *query_key;
38 
42 static struct GNUNET_TIME_Relative timeout_request = { 60000 };
43 
47 static int verbose;
48 
53 
57 static const struct GNUNET_CONFIGURATION_Handle *cfg;
58 
63 
67 static unsigned int result_count;
68 
72 static int ret;
73 
77 static struct GNUNET_SCHEDULER_Task *tt;
78 
79 
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  {
103  tt = NULL;
104  }
105 }
106 
107 
113 static void
114 timeout_task(void *cls)
115 {
116  tt = NULL;
118 }
119 
120 
133 static void
134 get_callback(void *cls,
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 
166 static void
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,
184  (int)type,
185  GNUNET_h2s_full(key),
186  (unsigned int)size,
187  (char *)data);
188  result_count++;
189 }
190 
191 
207 static void
208 put_callback(void *cls,
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,
226  (int)type,
227  GNUNET_h2s_full(key),
228  (unsigned int)size,
229  (char *)data);
230  result_count++;
231 }
232 
233 
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 */
261  if (NULL != query_key)
262  {
263  key = &hc;
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",
275  GNUNET_NO));
276  tt = GNUNET_SCHEDULER_add_delayed(timeout_request, &timeout_task, NULL);
278  monitor_handle = GNUNET_DHT_monitor_start(dht_handle,
279  block_type,
280  key,
281  &get_callback,
283  &put_callback,
284  NULL);
285 }
286 
294 int
295 main(int argc, char *const *argv)
296 {
297  struct GNUNET_GETOPT_CommandLineOption options[] = {
299  "key",
300  "KEY",
301  gettext_noop("the query key"),
302  &query_key),
303 
305  "type",
306  "TYPE",
307  gettext_noop("the type of data to look for"),
308  &block_type),
309 
311  'T',
312  "timeout",
313  "TIMEOUT",
314  gettext_noop("how long should the monitor command run"),
315  &timeout_request),
316 
318  "verbose",
319  gettext_noop(
320  "be verbose (print progress information)"),
321  &verbose),
322 
324  };
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 */
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_relative_time(char shortName, const char *name, const char *argumentHelp, const char *description, struct GNUNET_TIME_Relative *val)
Allow user to specify a struct GNUNET_TIME_Relative (using human-readable "fancy" time)...
static int verbose
Be verbose.
int main(int argc, char *const *argv)
Entry point for gnunet-dht-monitor.
static const struct GNUNET_CONFIGURATION_Handle * cfg
Global handle of the configuration.
Any type of block, used as a wildcard when searching.
struct GNUNET_GETOPT_CommandLineOption options[]
Definition: 002.c:5
GNUNET_BLOCK_Type
Blocks in the datastore and the datacache must have a unique type.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_shutdown(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run on shutdown, that is when a CTRL-C signal is received, or when GNUNET_SCHEDULER_shutdown() is being invoked.
Definition: scheduler.c:1284
static void timeout_task(void *cls)
We hit a timeout.
int GNUNET_STRINGS_get_utf8_args(int argc, char *const *argv, int *u8argc, char *const **u8argv)
Returns utf-8 encoded arguments.
Definition: strings.c:1439
static struct GNUNET_SCHEDULER_Task * tt
Task scheduled to handle timeout.
void GNUNET_DHT_monitor_stop(struct GNUNET_DHT_MonitorHandle *mh)
Stop monitoring.
Definition: dht_api.c:1234
static struct GNUNET_DHT_Handle * dht_handle
Handle to the DHT.
static void put_callback(void *cls, enum GNUNET_DHT_RouteOption options, enum GNUNET_BLOCK_Type type, uint32_t hop_count, uint32_t desired_replication_level, unsigned int path_length, const struct GNUNET_PeerIdentity *path, struct GNUNET_TIME_Absolute exp, const struct GNUNET_HashCode *key, const void *data, size_t size)
Callback called on each PUT request going through the DHT.
#define GNUNET_NO
Definition: gnunet_common.h:78
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
static struct GNUNET_TIME_Relative timeout_request
User supplied timeout value (in seconds)
Definition of a command line option.
void GNUNET_SCHEDULER_shutdown(void)
Request the shutdown of a scheduler.
Definition: scheduler.c:517
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_OPTION_END
Definition: 002.c:13
Connection to the DHT service.
Definition: dht_api.c:198
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_string(char shortName, const char *name, const char *argumentHelp, const char *description, char **str)
Allow user to specify a string.
static char * query_key
The key to be monitored.
#define _(String)
GNU gettext support macro.
Definition: platform.h:181
static void run(void *cls, char *const *args, const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *c)
Main function that will be run by the scheduler.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_delayed(struct GNUNET_TIME_Relative delay, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay.
Definition: scheduler.c:1237
struct GNUNET_DHT_MonitorHandle * GNUNET_DHT_monitor_start(struct GNUNET_DHT_Handle *handle, enum GNUNET_BLOCK_Type type, const struct GNUNET_HashCode *key, GNUNET_DHT_MonitorGetCB get_cb, GNUNET_DHT_MonitorGetRespCB get_resp_cb, GNUNET_DHT_MonitorPutCB put_cb, void *cb_cls)
Start monitoring the local DHT service.
Definition: dht_api.c:1195
void GNUNET_CRYPTO_hash(const void *block, size_t size, struct GNUNET_HashCode *ret)
Compute hash of a given block.
Definition: crypto_hash.c:44
const char * GNUNET_STRINGS_relative_time_to_string(struct GNUNET_TIME_Relative delta, int do_round)
Give relative time in human-readable fancy format.
Definition: strings.c:686
static unsigned int result_count
Count of messages received.
A 512-bit hashcode.
GNUNET_DHT_RouteOption
Options for routing.
static void get_resp_callback(void *cls, enum GNUNET_BLOCK_Type type, const struct GNUNET_PeerIdentity *get_path, unsigned int get_path_length, const struct GNUNET_PeerIdentity *put_path, unsigned int put_path_length, struct GNUNET_TIME_Absolute exp, const struct GNUNET_HashCode *key, const void *data, size_t size)
Callback called on each GET reply going through the DHT.
struct GNUNET_HashCode key
The key used in the DHT.
static unsigned int size
Size of the "table".
Definition: peer.c:66
struct GNUNET_DHT_Handle * GNUNET_DHT_connect(const struct GNUNET_CONFIGURATION_Handle *cfg, unsigned int ht_len)
Initialize the connection with the DHT service.
Definition: dht_api.c:885
const char * GNUNET_h2s_full(const struct GNUNET_HashCode *hc)
Convert a hash value to a string (for printing debug messages).
void GNUNET_DHT_disconnect(struct GNUNET_DHT_Handle *handle)
Shutdown connection with the DHT service.
Definition: dht_api.c:913
static int ret
Global status value.
static struct GNUNET_DHT_MonitorHandle * monitor_handle
Handle for the get request.
The identity of the host (wraps the signing key of the peer).
configuration data
Definition: configuration.c:83
Block for testing.
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_flag(char shortName, const char *name, const char *description, int *val)
Allow user to specify a flag (which internally means setting an integer to 1/GNUNET_YES/GNUNET_OK.
Entry in list of pending tasks.
Definition: scheduler.c:131
static void cleanup_task(void *cls)
Stop monitoring request and start shutdown.
int GNUNET_PROGRAM_run(int argc, char *const *argv, const char *binaryName, const char *binaryHelp, const struct GNUNET_GETOPT_CommandLineOption *options, GNUNET_PROGRAM_Main task, void *task_cls)
Run a standard GNUnet command startup sequence (initialize loggers and configuration, parse options).
Definition: program.c:367
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model
Time for absolute times used by GNUnet, in microseconds.
static unsigned int block_type
The type of the query.
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_uint(char shortName, const char *name, const char *argumentHelp, const char *description, unsigned int *val)
Allow user to specify an unsigned int.
const char * GNUNET_STRINGS_absolute_time_to_string(struct GNUNET_TIME_Absolute t)
Like asctime, except for GNUnet time.
Definition: strings.c:741
uint32_t data
The data value.
#define GNUNET_CRYPTO_hash_from_string(enc, result)
Convert ASCII encoding back to struct GNUNET_HashCode
Handle to a monitoring request.
Definition: dht_api.c:147
Time for relative time used by GNUnet, in microseconds.
#define gettext_noop(String)
Definition: gettext.h:69
static void get_callback(void *cls, enum GNUNET_DHT_RouteOption options, enum GNUNET_BLOCK_Type type, uint32_t hop_count, uint32_t desired_replication_level, unsigned int path_length, const struct GNUNET_PeerIdentity *path, const struct GNUNET_HashCode *key)
Callback called on each GET request going through the DHT.
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:956