GNUnet  0.10.x
gnunet-dht-get.c
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2001, 2002, 2004, 2005, 2006, 2007, 2009 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 
29 #define LOG(kind,...) GNUNET_log_from (kind, "dht-clients",__VA_ARGS__)
30 
33 static unsigned int query_type;
34 
38 static unsigned int replication = 5;
39 
43 static char *query_key;
44 
48 static struct GNUNET_TIME_Relative timeout_request = { 60000 };
49 
53 static unsigned int verbose;
54 
59 
64 
68 static const struct GNUNET_CONFIGURATION_Handle *cfg;
69 
74 
78 static unsigned int result_count;
79 
83 static int ret;
84 
88 static struct GNUNET_SCHEDULER_Task *tt;
89 
90 
96 static void
97 cleanup_task (void *cls)
98 {
99  if (NULL != get_handle)
100  {
101  GNUNET_DHT_get_stop (get_handle);
102  get_handle = NULL;
103  }
104  if (NULL != dht_handle)
105  {
106  GNUNET_DHT_disconnect (dht_handle);
107  dht_handle = NULL;
108  }
109  if (NULL != tt)
110  {
112  tt = NULL;
113  }
114 }
115 
116 
122 static void
123 timeout_task (void *cls)
124 {
125  tt = NULL;
127 }
128 
129 
145 static void
147  const struct GNUNET_HashCode * key,
148  const struct GNUNET_PeerIdentity *get_path,
149  unsigned int get_path_length,
150  const struct GNUNET_PeerIdentity *put_path,
151  unsigned int put_path_length,
152  enum GNUNET_BLOCK_Type type,
153  size_t size,
154  const void *data)
155 {
156  FPRINTF (stdout,
157  (GNUNET_BLOCK_TYPE_TEST == type)
158  ? _("Result %d, type %d:\n%.*s\n")
159  : _("Result %d, type %d:\n"),
160  result_count,
161  type,
162  (unsigned int) size,
163  (char *) data);
164  if (verbose)
165  {
166  FPRINTF (stdout,
167  " GET path: ");
168  for (unsigned int i=0;i<get_path_length;i++)
169  FPRINTF (stdout,
170  "%s%s",
171  (0 == i) ? "" : "-",
172  GNUNET_i2s (&get_path[i]));
173  FPRINTF (stdout,
174  "\n PUT path: ");
175  for (unsigned int i=0;i<put_path_length;i++)
176  FPRINTF (stdout,
177  "%s%s",
178  (0 == i) ? "" : "-",
179  GNUNET_i2s (&put_path[i]));
180  FPRINTF (stdout,
181  "\n");
182  }
183  result_count++;
184 }
185 
186 
195 static void
196 run (void *cls, char *const *args, const char *cfgfile,
197  const struct GNUNET_CONFIGURATION_Handle *c)
198 {
199  struct GNUNET_HashCode key;
200 
201  cfg = c;
202  if (NULL == query_key)
203  {
204  FPRINTF (stderr, "%s", _("Must provide key for DHT GET!\n"));
205  ret = 1;
206  return;
207  }
208  if (NULL == (dht_handle = GNUNET_DHT_connect (cfg, 1)))
209  {
210  FPRINTF (stderr, "%s", _("Failed to connect to DHT service!\n"));
211  ret = 1;
212  return;
213  }
214  if (query_type == GNUNET_BLOCK_TYPE_ANY) /* Type of data not set */
216  GNUNET_CRYPTO_hash (query_key, strlen (query_key), &key);
217  if (verbose)
218  FPRINTF (stderr, "%s `%s' \n",
219  _("Issuing DHT GET with key"),
220  GNUNET_h2s_full (&key));
222  tt = GNUNET_SCHEDULER_add_delayed (timeout_request,
223  &timeout_task,
224  NULL);
225  get_handle =
226  GNUNET_DHT_get_start (dht_handle, query_type, &key, replication,
228  NULL, 0,
230  NULL);
231 }
232 
233 
241 int
242 main (int argc, char *const *argv)
243 {
244  struct GNUNET_GETOPT_CommandLineOption options[] = {
246  "key",
247  "KEY",
248  gettext_noop ("the query key"),
249  &query_key),
251  "replication",
252  "LEVEL",
253  gettext_noop ("how many parallel requests (replicas) to create"),
254  &replication),
256  "type",
257  "TYPE",
258  gettext_noop ("the type of data to look for"),
259  &query_type),
261  "timeout",
262  "TIMEOUT",
263  gettext_noop ("how long to execute this query before giving up?"),
264  &timeout_request),
266  "demultiplex",
267  gettext_noop ("use DHT's demultiplex everywhere option"),
271  };
272 
273 
274 
275  if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
276  return 2;
277  return (GNUNET_OK ==
278  GNUNET_PROGRAM_run (argc, argv, "gnunet-dht-get",
280  ("Issue a GET request to the GNUnet DHT, prints results."),
281  options, &run, NULL)) ? ret : 1;
282 }
283 
284 /* end of gnunet-dht-get.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 void timeout_task(void *cls)
Task run on timeout.
Any type of block, used as a wildcard when searching.
GNUNET_BLOCK_Type
Blocks in the datastore and the datacache must have a unique type.
#define FPRINTF
Definition: plibc.h:683
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:1293
static struct GNUNET_TIME_Relative timeout_request
User supplied timeout value.
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_verbose(unsigned int *level)
Define the &#39;-V&#39; verbosity option.
int GNUNET_STRINGS_get_utf8_args(int argc, char *const *argv, int *u8argc, char *const **u8argv)
Returns utf-8 encoded arguments.
Definition: strings.c:1521
static unsigned int query_type
The type of the query.
static char * query_key
The key for the query.
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:78
Definition of a command line option.
void GNUNET_SCHEDULER_shutdown(void)
Request the shutdown of a scheduler.
Definition: scheduler.c:524
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_OPTION_END
Definition: 002.c:13
Connection to the DHT service.
Definition: dht_api.c:205
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.
#define _(String)
GNU gettext support macro.
Definition: platform.h:208
static struct GNUNET_DHT_Handle * dht_handle
Handle to the DHT.
static struct GNUNET_DHT_GetHandle * get_handle
Handle for the get request.
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:1246
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
static int demultixplex_everywhere
Use DHT demultixplex_everywhere.
A 512-bit hashcode.
void GNUNET_DHT_get_stop(struct GNUNET_DHT_GetHandle *get_handle)
Stop async DHT-get.
Definition: dht_api.c:1160
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.
static unsigned int result_count
Count of results found.
static unsigned int replication
Desired replication level.
static void cleanup_task(void *cls)
Task run to clean up on shutdown.
static void get_result_iterator(void *cls, struct GNUNET_TIME_Absolute exp, const struct GNUNET_HashCode *key, const struct GNUNET_PeerIdentity *get_path, unsigned int get_path_length, const struct GNUNET_PeerIdentity *put_path, unsigned int put_path_length, enum GNUNET_BLOCK_Type type, size_t size, const void *data)
Iterator called on each result obtained for a DHT operation that expects a reply. ...
static unsigned int verbose
Be verbose.
struct GNUNET_HashCode key
The key used in the DHT.
static unsigned int size
Size of the "table".
Definition: peer.c:67
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:895
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:923
Handle to a GET request.
Definition: dht_api.c:80
The identity of the host (wraps the signing key of the peer).
configuration data
Definition: configuration.c:85
Block for testing.
static int ret
Global status value.
struct GNUNET_DHT_GetHandle * GNUNET_DHT_get_start(struct GNUNET_DHT_Handle *handle, enum GNUNET_BLOCK_Type type, const struct GNUNET_HashCode *key, uint32_t desired_replication_level, enum GNUNET_DHT_RouteOption options, const void *xquery, size_t xquery_size, GNUNET_DHT_GetIterator iter, void *iter_cls)
Perform an asynchronous GET operation on the DHT identified.
Definition: dht_api.c:1072
static struct GNUNET_SCHEDULER_Task * tt
Task scheduled to handle timeout.
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:134
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:361
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model
Time for absolute times used by GNUnet, in microseconds.
int main(int argc, char *const *argv)
Entry point for gnunet-dht-get.
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.
static const struct GNUNET_CONFIGURATION_Handle * cfg
Global handle of the configuration.
uint32_t data
The data value.
const char * GNUNET_i2s(const struct GNUNET_PeerIdentity *pid)
Convert a peer identity to a string (for printing debug messages).
Each peer along the way should look at &#39;enc&#39; (otherwise only the k-peers closest to the key should lo...
Time for relative time used by GNUnet, in microseconds.
#define gettext_noop(String)
Definition: gettext.h:69
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:965