gnunet-dht-get.c File Reference

search for data in DHT More...

#include "platform.h"
#include "gnunet_dht_service.h"

Include dependency graph for gnunet-dht-get.c:

Go to the source code of this file.

Macros
#define	LOG(kind, ...)   GNUNET_log_from (kind, "dht-clients", __VA_ARGS__)

Functions
static void	cleanup_task (void *cls)
	Task run to clean up on shutdown. More...
static void	timeout_task (void *cls)
	Task run on timeout. More...
static void	get_result_iterator (void *cls, struct GNUNET_TIME_Absolute exp, const struct GNUNET_HashCode *key, const struct GNUNET_PeerIdentity *trunc_peer, const struct GNUNET_DHT_PathElement *get_path, unsigned int get_path_length, const struct GNUNET_DHT_PathElement *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. More...
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. More...
int	main (int argc, char *const *argv)
	Entry point for gnunet-dht-get. More...

Variables
static unsigned int	query_type
	The type of the query. More...
static unsigned int	replication = 5
	Desired replication level. More...
static char *	query_key
	The key for the query. More...
static struct GNUNET_TIME_Relative	timeout_request = { 60000 }
	User supplied timeout value. More...
static unsigned int	verbose
	Be verbose. More...
static int	demultixplex_everywhere
	Use DHT demultixplex_everywhere. More...
static int	record_route
	Use GNUNET_DHT_RO_RECORD_ROUTE. More...
static struct GNUNET_DHT_Handle *	dht_handle
	Handle to the DHT. More...
static const struct GNUNET_CONFIGURATION_Handle *	cfg
	Global handle of the configuration. More...
static struct GNUNET_DHT_GetHandle *	get_handle
	Handle for the get request. More...
static unsigned int	result_count
	Count of results found. More...
static int	ret
	Global status value. More...
static struct GNUNET_SCHEDULER_Task *	tt
	Task scheduled to handle timeout. More...

Detailed Description

search for data in DHT

Author

Christian Grothoff

Nathan Evans

Definition in file gnunet-dht-get.c.

Macro Definition Documentation

LOG

#define LOG	(		kind,
			...
	)		GNUNET_log_from (kind, "dht-clients", __VA_ARGS__)

Definition at line 29 of file gnunet-dht-get.c.

Function Documentation

cleanup_task()

static void cleanup_task ( void *  cls )

static

Task run to clean up on shutdown.

Parameters

cls

unused

Definition at line 102 of file gnunet-dht-get.c.

{
  if (NULL != get_handle)
  {
    GNUNET_DHT_get_stop (get_handle);
    get_handle = NULL;
  }
  if (NULL != dht_handle)
  {
    GNUNET_DHT_disconnect (dht_handle);
    dht_handle = NULL;
  }
  if (NULL != tt)
  {
    GNUNET_SCHEDULER_cancel (tt);
    tt = NULL;
  }
}

References dht_handle, get_handle, GNUNET_DHT_disconnect(), GNUNET_DHT_get_stop(), GNUNET_SCHEDULER_cancel(), and tt.

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

timeout_task()

static void timeout_task ( void *  cls )

static

Task run on timeout.

Triggers shutdown.

Parameters

cls

unused

Definition at line 128 of file gnunet-dht-get.c.

{
  tt = NULL;
  GNUNET_SCHEDULER_shutdown ();
}

References GNUNET_SCHEDULER_shutdown(), and tt.

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

get_result_iterator()

static void get_result_iterator ( void *  cls, struct GNUNET_TIME_Absolute  exp, const struct GNUNET_HashCode *  key, const struct GNUNET_PeerIdentity *  trunc_peer, const struct GNUNET_DHT_PathElement *  get_path, unsigned int  get_path_length, const struct GNUNET_DHT_PathElement *  put_path, unsigned int  put_path_length, enum GNUNET_BLOCK_Type  type, size_t  size, const void *  data  )

static

Iterator called on each result obtained for a DHT operation that expects a reply.

Parameters

cls	closure
exp	when will this value expire
key	key of the result
trunc_peer	peer at which the path was truncated, or NULL if not
get_path	peers on reply path (or NULL if not recorded)
get_path_length	number of entries in get_path
put_path	peers on the PUT path (or NULL if not recorded)
put_path_length	number of entries in get_path
type	type of the result
size	number of bytes in data
data	pointer to the result data

Definition at line 152 of file gnunet-dht-get.c.

{
  fprintf (stdout,
           (GNUNET_BLOCK_TYPE_TEST == type)
           ? _ ("Result %d, type %d:\n%.*s\n")
           : _ ("Result %d, type %d:\n"),
           result_count,
           type,
           (int) size,
           (char *) data);
  if (record_route && verbose)
  {
    {
      struct GNUNET_PeerIdentity my_identity;
 
      GNUNET_break (GNUNET_OK ==
                    GNUNET_CRYPTO_get_peer_identity (cfg,
                                                     &my_identity));
      GNUNET_break (0 ==
                    GNUNET_DHT_verify_path (data,
                                            size,
                                            exp,
                                            trunc_peer,
                                            put_path,
                                            put_path_length,
                                            get_path,
                                            get_path_length,
                                            &my_identity));
    }
    fprintf (stdout,
             "  GET path: ");
    for (unsigned int i = 0; i < get_path_length; i++)
      fprintf (stdout,
               "%s%s",
               (0 == i) ? "" : "-",
               GNUNET_i2s (&get_path[i].pred));
    fprintf (stdout,
             "\n  PUT path: ");
    for (unsigned int i = 0; i < put_path_length; i++)
      fprintf (stdout,
               "%s%s",
               (0 == i) ? "" : "-",
               GNUNET_i2s (&put_path[i].pred));
    if (NULL != trunc_peer)
      fprintf (stdout,
               "!%s",
               GNUNET_i2s (trunc_peer));
    fprintf (stdout,
             "\n");
  }
  result_count++;
}

References _, cfg, data, GNUNET_BLOCK_TYPE_TEST, GNUNET_break, GNUNET_CRYPTO_get_peer_identity(), GNUNET_DHT_verify_path(), GNUNET_i2s(), GNUNET_OK, my_identity, record_route, result_count, size, type, and verbose.

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

run()

static void run ( void *  cls, char *const *  args, const char *  cfgfile, const struct GNUNET_CONFIGURATION_Handle *  c  )

static

Main function that will be run by the scheduler.

Parameters

cls	closure
args	remaining command-line arguments
cfgfile	name of the configuration file used (for saving, can be NULL!)
c	configuration

Definition at line 225 of file gnunet-dht-get.c.

{
  struct GNUNET_HashCode key;
  enum GNUNET_DHT_RouteOption ro;
 
  cfg = c;
  if (NULL == query_key)
  {
    fprintf (stderr,
             "%s",
             _ ("Must provide key for DHT GET!\n"));
    ret = 1;
    return;
  }
  if (NULL == (dht_handle = GNUNET_DHT_connect (cfg, 1)))
  {
    fprintf (stderr,
             "%s",
             _ ("Failed to connect to DHT service!\n"));
    ret = 1;
    return;
  }
  if (query_type == GNUNET_BLOCK_TYPE_ANY) /* Type of data not set */
    query_type = GNUNET_BLOCK_TYPE_TEST;
  GNUNET_CRYPTO_hash (query_key, strlen (query_key), &key);
  if (verbose)
    fprintf (stderr,
             "%s `%s' \n",
             _ ("Issuing DHT GET with key"),
             GNUNET_h2s_full (&key));
  GNUNET_SCHEDULER_add_shutdown (&cleanup_task, NULL);
  tt = GNUNET_SCHEDULER_add_delayed (timeout_request, &timeout_task, NULL);
  ro = GNUNET_DHT_RO_NONE;
  if (demultixplex_everywhere)
    ro |= GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE;
  if (record_route)
    ro |= GNUNET_DHT_RO_RECORD_ROUTE;
  get_handle = GNUNET_DHT_get_start (dht_handle,
                                     query_type,
                                     &key,
                                     replication,
                                     ro,
                                     NULL,
                                     0,
                                     &get_result_iterator,
                                     NULL);
}

References _, cfg, cleanup_task(), demultixplex_everywhere, dht_handle, get_handle, get_result_iterator(), GNUNET_BLOCK_TYPE_ANY, GNUNET_BLOCK_TYPE_TEST, GNUNET_CRYPTO_hash(), GNUNET_DHT_connect(), GNUNET_DHT_get_start(), GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE, GNUNET_DHT_RO_NONE, GNUNET_DHT_RO_RECORD_ROUTE, GNUNET_h2s_full(), GNUNET_SCHEDULER_add_delayed(), GNUNET_SCHEDULER_add_shutdown(), key, query_key, query_type, record_route, replication, ret, timeout_request, timeout_task(), tt, and verbose.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

main()

int main	(	int	argc,
		char *const *	argv
	)

Entry point for gnunet-dht-get.

Parameters

argc	number of arguments from the command line
argv	command line arguments

Returns

0 ok, 1 on error

Definition at line 285 of file gnunet-dht-get.c.

{
  struct GNUNET_GETOPT_CommandLineOption options[] = {
    GNUNET_GETOPT_option_string (
      'k',
      "key",
      "KEY",
      gettext_noop ("the query key"),
      &query_key),
    GNUNET_GETOPT_option_uint (
      'r',
      "replication",
      "LEVEL",
      gettext_noop ("how many parallel requests (replicas) to create"),
      &replication),
    GNUNET_GETOPT_option_flag (
      'R',
      "record",
      gettext_noop ("use DHT's record route option"),
      &record_route),
    GNUNET_GETOPT_option_uint (
      't',
      "type",
      "TYPE",
      gettext_noop ("the type of data to look for"),
      &query_type),
    GNUNET_GETOPT_option_relative_time (
      'T',
      "timeout",
      "TIMEOUT",
      gettext_noop ("how long to execute this query before giving up?"),
      &timeout_request),
    GNUNET_GETOPT_option_flag (
      'x',
      "demultiplex",
      gettext_noop (
        "use DHT's demultiplex everywhere option"),
      &demultixplex_everywhere),
    GNUNET_GETOPT_option_verbose (&verbose),
    GNUNET_GETOPT_OPTION_END
  };
 
 
  ret = (GNUNET_OK ==
         GNUNET_PROGRAM_run (
           GNUNET_OS_project_data_gnunet (),
           argc,
           argv,
           "gnunet-dht-get",
           gettext_noop (
             "Issue a GET request to the GNUnet DHT, prints results."),
           options,
           &run,
           NULL))
         ? ret
         : 1;
  return ret;
}

References demultixplex_everywhere, gettext_noop, GNUNET_GETOPT_OPTION_END, GNUNET_GETOPT_option_flag(), GNUNET_GETOPT_option_relative_time(), GNUNET_GETOPT_option_string(), GNUNET_GETOPT_option_uint(), GNUNET_GETOPT_option_verbose(), GNUNET_OK, GNUNET_OS_project_data_gnunet(), GNUNET_PROGRAM_run(), options, query_key, query_type, record_route, replication, ret, run(), timeout_request, and verbose.

Here is the call graph for this function:

Variable Documentation

query_type

unsigned int query_type

static

The type of the query.

Definition at line 33 of file gnunet-dht-get.c.

Referenced by main(), and run().

replication

unsigned int replication = 5

static

Desired replication level.

Definition at line 38 of file gnunet-dht-get.c.

Referenced by execute_get(), get_cb(), GNUNET_DATASTORE_put(), GNUNET_FS_handle_on_demand_block(), handle_datastore_reply(), heap_plugin_put(), main(), postgres_plugin_put(), process_local_reply(), process_migration_content(), process_result(), repl_proc(), run(), sqlite_plugin_put(), and transmit_item().

query_key

char* query_key

static

The key for the query.

Definition at line 43 of file gnunet-dht-get.c.

Referenced by main(), and run().

timeout_request

struct GNUNET_TIME_Relative timeout_request = { 60000 }

static

User supplied timeout value.

Definition at line 48 of file gnunet-dht-get.c.

Referenced by main(), and run().

verbose

unsigned int verbose

static

Be verbose.

Definition at line 53 of file gnunet-dht-get.c.

Referenced by get_result_iterator(), main(), and run().

demultixplex_everywhere

int demultixplex_everywhere

static

Use DHT demultixplex_everywhere.

Definition at line 58 of file gnunet-dht-get.c.

Referenced by main(), and run().

record_route

int record_route

static

Use GNUNET_DHT_RO_RECORD_ROUTE.

Definition at line 63 of file gnunet-dht-get.c.

Referenced by get_result_iterator(), main(), and run().

dht_handle

struct GNUNET_DHT_Handle* dht_handle

static

Handle to the DHT.

Definition at line 68 of file gnunet-dht-get.c.

Referenced by cleanup_task(), and run().

cfg

const struct GNUNET_CONFIGURATION_Handle* cfg

static

Global handle of the configuration.

Definition at line 73 of file gnunet-dht-get.c.

Referenced by get_result_iterator(), and run().

get_handle

struct GNUNET_DHT_GetHandle* get_handle

static

Handle for the get request.

Definition at line 78 of file gnunet-dht-get.c.

Referenced by cleanup_task(), get_result_iterator(), GNUNET_DHT_get_filter_known_results(), GNUNET_DHT_get_stop(), process_client_result(), and run().

result_count

unsigned int result_count

static

Count of results found.

Definition at line 83 of file gnunet-dht-get.c.

Referenced by get_result_iterator().

ret

int ret

static

Global status value.

Definition at line 88 of file gnunet-dht-get.c.

Referenced by main(), and run().

tt

struct GNUNET_SCHEDULER_Task* tt

static

Task scheduled to handle timeout.

Definition at line 93 of file gnunet-dht-get.c.

Referenced by cleanup_task(), GNUNET_STRINGS_absolute_time_to_string(), GNUNET_TIME_absolute2s(), GNUNET_TIME_timestamp2s(), run(), and timeout_task().