gnunet-datastore.c File Reference

tool to manipulate datastores More...

#include "platform.h"
#include <inttypes.h>
#include "gnunet_util_lib.h"
#include "gnunet_datastore_service.h"

Include dependency graph for gnunet-datastore.c:

Go to the source code of this file.

Data Structures
struct	DataRecord

Functions
static void	do_shutdown (void *cls)
static void	start_dump (void)
	Begin dumping the database. More...
static void	start_insert (void)
	Begin inserting into the database. More...
static void	do_get (const uint64_t next_uid)
	Perform next GET operation. More...
static void	get_cb (void *cls, const struct GNUNET_HashCode *key, size_t size, const void *data, enum GNUNET_BLOCK_Type type, uint32_t priority, uint32_t anonymity, uint32_t replication, struct GNUNET_TIME_Absolute expiration, uint64_t uid)
	Process a datum that was stored in the datastore. More...
static void	put_cb (void *cls, int32_t success, struct GNUNET_TIME_Absolute min_expiration, const char *msg)
	Continuation called to notify client about result of the operation. More...
static void	run (void *cls, char *const *args, const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *cfg)
	Main function that will be run by the scheduler. More...
int	main (int argc, char *const *argv)
	The main function to manipulate datastores. More...

Variables
static GNUNET_NETWORK_STRUCT_END const size_t	MAGIC_LEN = 16
	Length of our magic header. More...
static const uint8_t	MAGIC_BYTES [16] = "GNUNETDATASTORE1"
	Magic header bytes. More...
static int	dump
	Dump the database. More...
static int	insert
	Insert into the database. More...
static char *	file_name
	Dump file name. More...
static struct GNUNET_DISK_FileHandle *	file_handle
	Dump file handle. More...
static int	ret
	Global return value. More...
static struct GNUNET_DATASTORE_Handle *	datastore
	Handle for datastore. More...
static struct GNUNET_DATASTORE_QueueEntry *	qe
	Current operation. More...
static uint64_t	record_count
	Record count. More...

Detailed Description

tool to manipulate datastores

Author

Christian Grothoff

Definition in file gnunet-datastore.c.

Function Documentation

do_shutdown()

static void do_shutdown ( void *  cls )

static

Definition at line 125 of file gnunet-datastore.c.

{
  if (NULL != qe)
    GNUNET_DATASTORE_cancel (qe);
  if (NULL != datastore)
    GNUNET_DATASTORE_disconnect (datastore, GNUNET_NO);
  if (NULL != file_handle)
    GNUNET_DISK_file_close (file_handle);
}

References datastore, file_handle, GNUNET_DATASTORE_cancel(), GNUNET_DATASTORE_disconnect(), GNUNET_DISK_file_close(), GNUNET_NO, and qe.

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

start_dump()

static void start_dump ( void  )

static

Begin dumping the database.

Definition at line 268 of file gnunet-datastore.c.

{
  record_count = 0;
 
  if (NULL != file_name)
  {
    file_handle = GNUNET_DISK_file_open (file_name,
                                         GNUNET_DISK_OPEN_WRITE
                                         | GNUNET_DISK_OPEN_TRUNCATE
                                         | GNUNET_DISK_OPEN_CREATE,
                                         GNUNET_DISK_PERM_USER_READ
                                         | GNUNET_DISK_PERM_USER_WRITE);
    if (NULL == file_handle)
    {
      fprintf (stderr, _ ("Unable to open dump file: %s\n"), file_name);
      ret = 1;
      GNUNET_SCHEDULER_shutdown ();
      return;
    }
  }
  else
  {
    file_handle = GNUNET_DISK_get_handle_from_int_fd (STDOUT_FILENO);
  }
  GNUNET_DISK_file_write (file_handle, MAGIC_BYTES, MAGIC_LEN);
  do_get (0);
}

References _, do_get(), file_handle, file_name, GNUNET_DISK_file_open(), GNUNET_DISK_file_write(), GNUNET_DISK_get_handle_from_int_fd(), GNUNET_DISK_OPEN_CREATE, GNUNET_DISK_OPEN_TRUNCATE, GNUNET_DISK_OPEN_WRITE, GNUNET_DISK_PERM_USER_READ, GNUNET_DISK_PERM_USER_WRITE, GNUNET_SCHEDULER_shutdown(), MAGIC_BYTES, MAGIC_LEN, record_count, and ret.

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

start_insert()

static void start_insert ( void  )

static

Begin inserting into the database.

Definition at line 391 of file gnunet-datastore.c.

{
  uint8_t buf[MAGIC_LEN];
  ssize_t len;
  record_count = 0;
 
  if (NULL != file_name)
  {
    file_handle = GNUNET_DISK_file_open (file_name,
                                         GNUNET_DISK_OPEN_READ,
                                         GNUNET_DISK_PERM_NONE);
    if (NULL == file_handle)
    {
      fprintf (stderr, _ ("Unable to open dump file: %s\n"), file_name);
      ret = 1;
      GNUNET_SCHEDULER_shutdown ();
      return;
    }
  }
  else
  {
    file_handle = GNUNET_DISK_get_handle_from_int_fd (STDIN_FILENO);
  }
 
  len = GNUNET_DISK_file_read (file_handle, buf, MAGIC_LEN);
  if ((len != MAGIC_LEN) || (0 != memcmp (buf, MAGIC_BYTES, MAGIC_LEN)))
  {
    fprintf (stderr, _ ("Input file is not of a supported format\n"));
    return;
  }
  put_cb (NULL, GNUNET_YES, GNUNET_TIME_UNIT_ZERO_ABS, NULL);
}

References _, file_handle, file_name, GNUNET_DISK_file_open(), GNUNET_DISK_file_read(), GNUNET_DISK_get_handle_from_int_fd(), GNUNET_DISK_OPEN_READ, GNUNET_DISK_PERM_NONE, GNUNET_SCHEDULER_shutdown(), GNUNET_TIME_UNIT_ZERO_ABS, GNUNET_YES, MAGIC_BYTES, MAGIC_LEN, put_cb(), record_count, and ret.

Referenced by get_cb(), and run().

Here is the call graph for this function:

Here is the caller graph for this function:

do_get()

static void do_get ( const uint64_t  next_uid )

static

Perform next GET operation.

Definition at line 243 of file gnunet-datastore.c.

{
  GNUNET_assert (NULL == qe);
  qe = GNUNET_DATASTORE_get_key (datastore,
                                 next_uid,
                                 false /* random */,
                                 NULL /* key */,
                                 GNUNET_BLOCK_TYPE_ANY,
                                 0 /* queue_priority */,
                                 1 /* max_queue_size */,
                                 &get_cb,
                                 NULL /* proc_cls */);
  if (NULL == qe)
  {
    fprintf (stderr, _ ("Error queueing datastore GET operation\n"));
    ret = 1;
    GNUNET_SCHEDULER_shutdown ();
  }
}

References _, datastore, get_cb(), GNUNET_assert, GNUNET_BLOCK_TYPE_ANY, GNUNET_DATASTORE_get_key(), GNUNET_SCHEDULER_shutdown(), qe, and ret.

Referenced by get_cb(), and start_dump().

Here is the call graph for this function:

Here is the caller graph for this function:

get_cb()

static void get_cb ( void *  cls, const struct GNUNET_HashCode *  key, size_t  size, const void *  data, enum GNUNET_BLOCK_Type  type, uint32_t  priority, uint32_t  anonymity, uint32_t  replication, struct GNUNET_TIME_Absolute  expiration, uint64_t  uid  )

static

Process a datum that was stored in the datastore.

Parameters

cls	closure
key	key for the content
size	number of bytes in data
data	content stored
type	type of the content
priority	priority of the content
anonymity	anonymity-level for the content
replication	replication-level for the content
expiration	expiration time for the content
uid	unique identifier for the datum; maybe 0 if no unique identifier is available

Definition at line 173 of file gnunet-datastore.c.

{
  struct DataRecord dr;
  ssize_t len;
  qe = NULL;
  if (NULL == key)
  {
    fprintf (stderr, _ ("Dumped %" PRIu64 " records\n"), record_count);
    GNUNET_DISK_file_close (file_handle);
    file_handle = NULL;
    if (insert)
      start_insert ();
    else
    {
      ret = 0;
      GNUNET_SCHEDULER_shutdown ();
    }
    return;
  }
 
  dr.size = htonl ((uint32_t) size);
  dr.type = htonl (type);
  dr.priority = htonl (priority);
  dr.anonymity = htonl (anonymity);
  dr.replication = htonl (replication);
  dr.expiration = GNUNET_TIME_absolute_hton (expiration);
  dr.key = *key;
 
  len = GNUNET_DISK_file_write (file_handle, &dr, sizeof(dr));
  if (sizeof(dr) != len)
  {
    fprintf (stderr,
             _ ("Short write to file: %zd bytes expecting %zd\n"),
             len,
             sizeof(dr));
    ret = 1;
    GNUNET_SCHEDULER_shutdown ();
    return;
  }
 
  len = GNUNET_DISK_file_write (file_handle, data, size);
  if (size != len)
  {
    fprintf (stderr,
             _ ("Short write to file: %zd bytes expecting %zd\n"),
             len,
             size);
    ret = 1;
    GNUNET_SCHEDULER_shutdown ();
    return;
  }
 
  record_count++;
  do_get (uid + 1);
}

References _, DataRecord::anonymity, anonymity, data, do_get(), DataRecord::expiration, expiration, file_handle, GNUNET_DISK_file_close(), GNUNET_DISK_file_write(), GNUNET_SCHEDULER_shutdown(), GNUNET_TIME_absolute_hton(), insert, DataRecord::key, key, DataRecord::priority, qe, record_count, DataRecord::replication, replication, ret, DataRecord::size, size, start_insert(), DataRecord::type, and type.

Referenced by do_get(), and GNUNET_DHT_monitor_start().

Here is the call graph for this function:

Here is the caller graph for this function:

put_cb()

static void put_cb ( void *  cls, int32_t  success, struct GNUNET_TIME_Absolute  min_expiration, const char *  msg  )

static

Continuation called to notify client about result of the operation.

Parameters

cls	closure
success	GNUNET_SYSERR on failure (including timeout/queue drop) GNUNET_NO if content was already there GNUNET_YES (or other positive value) on success
min_expiration	minimum expiration time required for 0-priority content to be stored by the datacache at this time, zero for unknown, forever if we have no space for 0-priority content
msg	NULL on success, otherwise an error message

Definition at line 311 of file gnunet-datastore.c.

{
  struct DataRecord dr;
  ssize_t len;
  qe = NULL;
  if (GNUNET_SYSERR == success)
  {
    fprintf (stderr, _ ("Failed to store item: %s, aborting\n"), msg);
    ret = 1;
    GNUNET_SCHEDULER_shutdown ();
    return;
  }
 
 
  len = GNUNET_DISK_file_read (file_handle, &dr, sizeof(dr));
  if (0 == len)
  {
    fprintf (stderr, _ ("Inserted %" PRIu64 " records\n"), record_count);
    ret = 0;
    GNUNET_SCHEDULER_shutdown ();
    return;
  }
  else if (sizeof(dr) != len)
  {
    fprintf (stderr,
             _ ("Short read from file: %zd bytes expecting %zd\n"),
             len,
             sizeof(dr));
    ret = 1;
    GNUNET_SCHEDULER_shutdown ();
    return;
  }
 
  {
    const size_t size = ntohl (dr.size);
    uint8_t data[size];
    len = GNUNET_DISK_file_read (file_handle, data, size);
    if (size != len)
    {
      fprintf (stderr,
               _ ("Short read from file: %zd bytes expecting %zd\n"),
               len,
               size);
      ret = 1;
      GNUNET_SCHEDULER_shutdown ();
      return;
    }
 
    record_count++;
    qe = GNUNET_DATASTORE_put (datastore,
                               0,
                               &dr.key,
                               size,
                               data,
                               ntohl (dr.type),
                               ntohl (dr.priority),
                               ntohl (dr.anonymity),
                               ntohl (dr.replication),
                               GNUNET_TIME_absolute_ntoh (dr.expiration),
                               0,
                               1,
                               &put_cb,
                               NULL);
    if (NULL == qe)
    {
      fprintf (stderr, _ ("Error queueing datastore PUT operation\n"));
      ret = 1;
      GNUNET_SCHEDULER_shutdown ();
    }
  }
}

References _, DataRecord::anonymity, data, datastore, DataRecord::expiration, file_handle, GNUNET_DATASTORE_put(), GNUNET_DISK_file_read(), GNUNET_SCHEDULER_shutdown(), GNUNET_SYSERR, GNUNET_TIME_absolute_ntoh(), DataRecord::key, msg, DataRecord::priority, put_cb(), qe, record_count, DataRecord::replication, ret, DataRecord::size, size, and DataRecord::type.

Referenced by GNUNET_DHT_monitor_start(), put_cb(), and start_insert().

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 *  cfg  )

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
cfg	configuration

Definition at line 434 of file gnunet-datastore.c.

{
  GNUNET_SCHEDULER_add_shutdown (&do_shutdown, NULL);
  datastore = GNUNET_DATASTORE_connect (cfg);
  if (NULL == datastore)
  {
    fprintf (stderr, _ ("Failed connecting to the datastore.\n"));
    ret = 1;
    GNUNET_SCHEDULER_shutdown ();
    return;
  }
  if (dump)
    start_dump ();
  else if (insert)
    start_insert ();
  else
  {
    fprintf (stderr,
             _ ("Please choose at least one operation: %s, %s\n"),
             "dump",
             "insert");
    ret = 1;
    GNUNET_SCHEDULER_shutdown ();
  }
}

References _, cfg, datastore, do_shutdown(), dump, GNUNET_DATASTORE_connect(), GNUNET_SCHEDULER_add_shutdown(), GNUNET_SCHEDULER_shutdown(), insert, ret, start_dump(), and start_insert().

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
	)

The main function to manipulate datastores.

Parameters

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

Returns

0 ok, 1 on error

Definition at line 472 of file gnunet-datastore.c.

{
  struct GNUNET_GETOPT_CommandLineOption options[] =
  { GNUNET_GETOPT_option_flag ('d',
                               "dump",
                               gettext_noop (
                                 "Dump all records from the datastore"),
                               &dump),
    GNUNET_GETOPT_option_flag ('i',
                               "insert",
                               gettext_noop (
                                 "Insert records into the datastore"),
                               &insert),
    GNUNET_GETOPT_option_filename ('f',
                                   "file",
                                   "FILENAME",
                                   gettext_noop ("File to dump or insert"),
                                   &file_name),
    GNUNET_GETOPT_OPTION_END };
 
  if (GNUNET_OK !=
      GNUNET_PROGRAM_run (GNUNET_OS_project_data_gnunet (),
                          argc,
                          argv,
                          "gnunet-datastore",
                          gettext_noop ("Manipulate GNUnet datastore"),
                          options,
                          &run,
                          NULL))
    ret = 1;
  return ret;
}

References dump, file_name, gettext_noop, GNUNET_GETOPT_OPTION_END, GNUNET_GETOPT_option_filename(), GNUNET_GETOPT_option_flag(), GNUNET_OK, GNUNET_OS_project_data_gnunet(), GNUNET_PROGRAM_run(), insert, options, ret, and run().

Here is the call graph for this function:

Variable Documentation

MAGIC_LEN

GNUNET_NETWORK_STRUCT_END const size_t MAGIC_LEN = 16

static

Length of our magic header.

Definition at line 76 of file gnunet-datastore.c.

Referenced by start_dump(), and start_insert().

MAGIC_BYTES

const uint8_t MAGIC_BYTES[16] = "GNUNETDATASTORE1"

static

Magic header bytes.

Definition at line 81 of file gnunet-datastore.c.

Referenced by start_dump(), and start_insert().

dump

int dump

static

Dump the database.

Definition at line 86 of file gnunet-datastore.c.

Referenced by main(), and run().

insert

int insert

static

Insert into the database.

Definition at line 91 of file gnunet-datastore.c.

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

file_name

char* file_name

static

Dump file name.

Definition at line 96 of file gnunet-datastore.c.

Referenced by GNUNET_TESTING_cmd_load_topology_from_file(), main(), start_dump(), start_insert(), store_prefix_file_name(), to_file_raw(), and to_file_raw_unaligned().

file_handle

struct GNUNET_DISK_FileHandle* file_handle

static

Dump file handle.

Definition at line 101 of file gnunet-datastore.c.

Referenced by do_shutdown(), get_cb(), put_cb(), start_dump(), and start_insert().

ret

int ret

static

Global return value.

Definition at line 106 of file gnunet-datastore.c.

Referenced by do_get(), get_cb(), main(), put_cb(), run(), start_dump(), and start_insert().

datastore

struct GNUNET_DATASTORE_Handle* datastore

static

Handle for datastore.

Definition at line 111 of file gnunet-datastore.c.

Referenced by do_get(), do_shutdown(), put_cb(), and run().

qe

struct GNUNET_DATASTORE_QueueEntry* qe

static

Current operation.

Definition at line 116 of file gnunet-datastore.c.

Referenced by add_continuation(), delay_warning(), do_get(), do_shutdown(), find_qe(), force_reconnect(), free_pending_message(), free_qe(), free_queue(), free_queue_entry(), get_cb(), get_queue_head(), GNUNET_DATASTORE_cancel(), GNUNET_DATASTORE_disconnect(), GNUNET_DATASTORE_get_for_replication(), GNUNET_DATASTORE_get_key(), GNUNET_DATASTORE_get_zero_anonymity(), GNUNET_DATASTORE_put(), GNUNET_DATASTORE_release_reserve(), GNUNET_DATASTORE_remove(), GNUNET_DATASTORE_reserve(), GNUNET_FS_dequeue_(), GNUNET_FS_queue_(), GNUNET_NAMECACHE_block_cache(), GNUNET_NAMECACHE_cancel(), GNUNET_NAMECACHE_lookup_block(), GNUNET_NAMESTORE_cancel(), GNUNET_NAMESTORE_record_set_edit_begin(), GNUNET_NAMESTORE_record_set_edit_cancel(), GNUNET_NAMESTORE_records_store(), GNUNET_NAMESTORE_zone_to_name(), handle_block_cache_response(), handle_data(), handle_data_end(), handle_edit_record_set_response(), handle_generic_response(), handle_lookup_block_response(), handle_lookup_result(), handle_record_result(), handle_record_result_end(), handle_send_message_ack(), handle_status(), handle_zone_to_name_response(), make_queue_entry(), mq_error_handler(), process_job_queue(), process_queue(), put_cb(), queue_send_msg(), reconnect(), records_lookup(), start_job(), stop_job(), and warn_delay().

record_count

uint64_t record_count

static

Record count.

Definition at line 121 of file gnunet-datastore.c.

Referenced by database_setup(), get_cb(), get_records_and_call_iterator(), parse_result_call_iterator(), put_cb(), start_dump(), and start_insert().