gnunet-service-fs_put.c File Reference

API to PUT zero-anonymity index data from our datastore into the DHT. More...

#include "platform.h"
#include "gnunet-service-fs.h"
#include "gnunet-service-fs_put.h"

Include dependency graph for gnunet-service-fs_put.c:

Go to the source code of this file.

Data Structures
struct	PutOperator
	Context for each zero-anonymity iterator. More...

Macros
#define	MAX_DHT_PUT_FREQ
	How often do we at most PUT content into the DHT?
#define	DEFAULT_PUT_REPLICATION   5
	How many replicas do we try to create per PUT?

Functions
static void	gather_dht_put_blocks (void *cls)
	Task that is run periodically to obtain blocks for DHT PUTs.
static void	schedule_next_put (struct PutOperator *po)
	Calculate when to run the next PUT operation and schedule it.
static void	delay_dht_put_blocks (void *cls)
	Continuation called after DHT PUT operation has finished.
static void	delay_dht_put_task (void *cls)
	Task that is run periodically to obtain blocks for DHT PUTs.
static void	process_dht_put_content (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)
	Store content in DHT.
void	GSF_put_init_ ()
	Setup the module.
void	GSF_put_done_ ()
	Shutdown the module.

Variables
static struct PutOperator	operators []
	ANY-terminated list of our operators (one per type of block that we're putting into the DHT).

Detailed Description

API to PUT zero-anonymity index data from our datastore into the DHT.

Author

Christian Grothoff

Definition in file gnunet-service-fs_put.c.

Macro Definition Documentation

MAX_DHT_PUT_FREQ

#define MAX_DHT_PUT_FREQ

Value:

    GNUNET_TIME_relative_multiply ( \
    GNUNET_TIME_UNIT_SECONDS, 5)

How often do we at most PUT content into the DHT?

Definition at line 34 of file gnunet-service-fs_put.c.

{
  struct GNUNET_DATASTORE_QueueEntry *dht_qe;
 
  enum GNUNET_BLOCK_Type dht_put_type;
 
  struct GNUNET_DHT_PutHandle *dht_put;
 
  struct GNUNET_SCHEDULER_Task *dht_task;
 
  uint64_t zero_anonymity_count_estimate;
 
  uint64_t result_count;
 
  uint64_t next_uid;
};
 
 
static struct PutOperator operators[] = {
  { NULL, GNUNET_BLOCK_TYPE_FS_UBLOCK, 0, 0, 0 },
  { NULL, GNUNET_BLOCK_TYPE_ANY, 0, 0, 0 }
};
 
 
static void
gather_dht_put_blocks (void *cls);
 
 
static void
schedule_next_put (struct PutOperator *po)
{
  struct GNUNET_TIME_Relative delay;
 
  if (po->zero_anonymity_count_estimate > 0)
  {
    delay =
      GNUNET_TIME_relative_divide (GNUNET_DHT_DEFAULT_REPUBLISH_FREQUENCY,
                                   po->zero_anonymity_count_estimate);
    delay = GNUNET_TIME_relative_min (delay, MAX_DHT_PUT_FREQ);
  }
  else
  {
    /* if we have NO zero-anonymity content yet, wait 5 minutes for some to
     * (hopefully) appear */
    delay = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 5);
  }
  po->dht_task =
    GNUNET_SCHEDULER_add_delayed (delay, &gather_dht_put_blocks, po);
}
 
 
static void
delay_dht_put_blocks (void *cls)
{
  struct PutOperator *po = cls;
 
  po->dht_put = NULL;
  schedule_next_put (po);
}
 
 
static void
delay_dht_put_task (void *cls)
{
  struct PutOperator *po = cls;
 
  po->dht_task = NULL;
  schedule_next_put (po);
}
 
 
static void
process_dht_put_content (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)
{
  struct PutOperator *po = cls;
 
  po->dht_qe = NULL;
  if (key == NULL)
  {
    po->zero_anonymity_count_estimate = po->result_count;
    po->result_count = 0;
    po->next_uid = 0;
    po->dht_task = GNUNET_SCHEDULER_add_now (&delay_dht_put_task, po);
    return;
  }
  po->result_count++;
  po->next_uid = uid + 1;
  po->zero_anonymity_count_estimate =
    GNUNET_MAX (po->result_count, po->zero_anonymity_count_estimate);
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Retrieved block `%s' of type %u for DHT PUT\n", GNUNET_h2s (key),
              type);
  po->dht_put = GNUNET_DHT_put (GSF_dht,
                                key,
                                DEFAULT_PUT_REPLICATION,
                                GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE,
                                type,
                                size,
                                data,
                                expiration,
                                &delay_dht_put_blocks,
                                po);
}
 
 
static void
gather_dht_put_blocks (void *cls)
{
  struct PutOperator *po = cls;
 
  po->dht_task = NULL;
  po->dht_qe =
    GNUNET_DATASTORE_get_zero_anonymity (GSF_dsh,
                                         po->next_uid,
                                         0,
                                         UINT_MAX,
                                         po->dht_put_type,
                                         &process_dht_put_content,
                                         po);
  if (NULL == po->dht_qe)
    po->dht_task = GNUNET_SCHEDULER_add_now (&delay_dht_put_task, po);
}
 
 
void
GSF_put_init_ ()
{
  unsigned int i;
 
  i = 0;
  while (operators[i].dht_put_type != GNUNET_BLOCK_TYPE_ANY)
  {
    operators[i].dht_task =
      GNUNET_SCHEDULER_add_now (&gather_dht_put_blocks, &operators[i]);
    i++;
  }
}
 
 
void
GSF_put_done_ ()
{
  struct PutOperator *po;
  unsigned int i;
 
  i = 0;
  while ((po = &operators[i])->dht_put_type != GNUNET_BLOCK_TYPE_ANY)
  {
    if (NULL != po->dht_task)
    {
      GNUNET_SCHEDULER_cancel (po->dht_task);
      po->dht_task = NULL;
    }
    if (NULL != po->dht_put)
    {
      GNUNET_DHT_put_cancel (po->dht_put);
      po->dht_put = NULL;
    }
    if (NULL != po->dht_qe)
    {
      GNUNET_DATASTORE_cancel (po->dht_qe);
      po->dht_qe = NULL;
    }
    i++;
  }
}
 
 
/* end of gnunet-service-fs_put.c */

DEFAULT_PUT_REPLICATION

#define DEFAULT_PUT_REPLICATION   5

How many replicas do we try to create per PUT?

Definition at line 40 of file gnunet-service-fs_put.c.

Function Documentation

gather_dht_put_blocks()

static void gather_dht_put_blocks ( void *  cls )

static

Task that is run periodically to obtain blocks for DHT PUTs.

Parameters

cls	type of blocks to gather

Definition at line 222 of file gnunet-service-fs_put.c.

{
  struct PutOperator *po = cls;
 
  po->dht_task = NULL;
  po->dht_qe =
    GNUNET_DATASTORE_get_zero_anonymity (GSF_dsh,
                                         po->next_uid,
                                         0,
                                         UINT_MAX,
                                         po->dht_put_type,
                                         &process_dht_put_content,
                                         po);
  if (NULL == po->dht_qe)
    po->dht_task = GNUNET_SCHEDULER_add_now (&delay_dht_put_task, po);
}

References delay_dht_put_task(), PutOperator::dht_put_type, PutOperator::dht_qe, PutOperator::dht_task, GNUNET_DATASTORE_get_zero_anonymity(), GNUNET_SCHEDULER_add_now(), GSF_dsh, PutOperator::next_uid, and process_dht_put_content().

Referenced by GSF_put_init_(), and schedule_next_put().

Here is the call graph for this function:

Here is the caller graph for this function:

schedule_next_put()

static void schedule_next_put ( struct PutOperator *  po )

static

Calculate when to run the next PUT operation and schedule it.

Parameters

po	put operator to schedule

Definition at line 111 of file gnunet-service-fs_put.c.

{
  struct GNUNET_TIME_Relative delay;
 
  if (po->zero_anonymity_count_estimate > 0)
  {
    delay =
      GNUNET_TIME_relative_divide (GNUNET_DHT_DEFAULT_REPUBLISH_FREQUENCY,
                                   po->zero_anonymity_count_estimate);
    delay = GNUNET_TIME_relative_min (delay, MAX_DHT_PUT_FREQ);
  }
  else
  {
    /* if we have NO zero-anonymity content yet, wait 5 minutes for some to
     * (hopefully) appear */
    delay = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 5);
  }
  po->dht_task =
    GNUNET_SCHEDULER_add_delayed (delay, &gather_dht_put_blocks, po);
}

References PutOperator::dht_task, gather_dht_put_blocks(), GNUNET_DHT_DEFAULT_REPUBLISH_FREQUENCY, GNUNET_SCHEDULER_add_delayed(), GNUNET_TIME_relative_divide(), GNUNET_TIME_relative_min(), GNUNET_TIME_relative_multiply(), GNUNET_TIME_UNIT_MINUTES, MAX_DHT_PUT_FREQ, and PutOperator::zero_anonymity_count_estimate.

Referenced by delay_dht_put_blocks(), and delay_dht_put_task().

Here is the call graph for this function:

Here is the caller graph for this function:

delay_dht_put_blocks()

static void delay_dht_put_blocks ( void *  cls )

static

Continuation called after DHT PUT operation has finished.

Parameters

cls	type of blocks to gather

Definition at line 139 of file gnunet-service-fs_put.c.

{
  struct PutOperator *po = cls;
 
  po->dht_put = NULL;
  schedule_next_put (po);
}

References PutOperator::dht_put, and schedule_next_put().

Referenced by process_dht_put_content().

Here is the call graph for this function:

Here is the caller graph for this function:

delay_dht_put_task()

static void delay_dht_put_task ( void *  cls )

static

Task that is run periodically to obtain blocks for DHT PUTs.

Parameters

cls	type of blocks to gather

Definition at line 154 of file gnunet-service-fs_put.c.

{
  struct PutOperator *po = cls;
 
  po->dht_task = NULL;
  schedule_next_put (po);
}

References PutOperator::dht_task, and schedule_next_put().

Referenced by gather_dht_put_blocks(), and process_dht_put_content().

Here is the call graph for this function:

Here is the caller graph for this function:

process_dht_put_content()

static void process_dht_put_content ( 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

Store content in DHT.

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 179 of file gnunet-service-fs_put.c.

{
  struct PutOperator *po = cls;
 
  po->dht_qe = NULL;
  if (key == NULL)
  {
    po->zero_anonymity_count_estimate = po->result_count;
    po->result_count = 0;
    po->next_uid = 0;
    po->dht_task = GNUNET_SCHEDULER_add_now (&delay_dht_put_task, po);
    return;
  }
  po->result_count++;
  po->next_uid = uid + 1;
  po->zero_anonymity_count_estimate =
    GNUNET_MAX (po->result_count, po->zero_anonymity_count_estimate);
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Retrieved block `%s' of type %u for DHT PUT\n", GNUNET_h2s (key),
              type);
  po->dht_put = GNUNET_DHT_put (GSF_dht,
                                key,
                                DEFAULT_PUT_REPLICATION,
                                GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE,
                                type,
                                size,
                                data,
                                expiration,
                                &delay_dht_put_blocks,
                                po);
}

References data, DEFAULT_PUT_REPLICATION, delay_dht_put_blocks(), delay_dht_put_task(), PutOperator::dht_put, PutOperator::dht_qe, PutOperator::dht_task, expiration, GNUNET_DHT_put(), GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE, GNUNET_ERROR_TYPE_DEBUG, GNUNET_h2s(), GNUNET_log, GNUNET_MAX, GNUNET_SCHEDULER_add_now(), GSF_dht, key, PutOperator::next_uid, PutOperator::result_count, size, type, and PutOperator::zero_anonymity_count_estimate.

Referenced by gather_dht_put_blocks().

Here is the call graph for this function:

Here is the caller graph for this function:

GSF_put_init_()

void GSF_put_init_

(

void

)

Setup the module.

Definition at line 244 of file gnunet-service-fs_put.c.

{
  unsigned int i;
 
  i = 0;
  while (operators[i].dht_put_type != GNUNET_BLOCK_TYPE_ANY)
  {
    operators[i].dht_task =
      GNUNET_SCHEDULER_add_now (&gather_dht_put_blocks, &operators[i]);
    i++;
  }
}

References PutOperator::dht_put_type, PutOperator::dht_task, gather_dht_put_blocks(), GNUNET_BLOCK_TYPE_ANY, GNUNET_SCHEDULER_add_now(), and operators.

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

GSF_put_done_()

void GSF_put_done_

(

void

)

Shutdown the module.

Definition at line 262 of file gnunet-service-fs_put.c.

{
  struct PutOperator *po;
  unsigned int i;
 
  i = 0;
  while ((po = &operators[i])->dht_put_type != GNUNET_BLOCK_TYPE_ANY)
  {
    if (NULL != po->dht_task)
    {
      GNUNET_SCHEDULER_cancel (po->dht_task);
      po->dht_task = NULL;
    }
    if (NULL != po->dht_put)
    {
      GNUNET_DHT_put_cancel (po->dht_put);
      po->dht_put = NULL;
    }
    if (NULL != po->dht_qe)
    {
      GNUNET_DATASTORE_cancel (po->dht_qe);
      po->dht_qe = NULL;
    }
    i++;
  }
}

References PutOperator::dht_put, PutOperator::dht_put_type, PutOperator::dht_qe, PutOperator::dht_task, GNUNET_BLOCK_TYPE_ANY, GNUNET_DATASTORE_cancel(), GNUNET_DHT_put_cancel(), GNUNET_SCHEDULER_cancel(), and operators.

Referenced by shutdown_task().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

operators

struct PutOperator operators[]

static

Initial value:

= {
  { NULL, GNUNET_BLOCK_TYPE_FS_UBLOCK, 0, 0, 0 },
  { NULL, GNUNET_BLOCK_TYPE_ANY, 0, 0, 0 }
}

ANY-terminated list of our operators (one per type of block that we're putting into the DHT).

Definition at line 90 of file gnunet-service-fs_put.c.

                                        {
  { NULL, GNUNET_BLOCK_TYPE_FS_UBLOCK, 0, 0, 0 },
  { NULL, GNUNET_BLOCK_TYPE_ANY, 0, 0, 0 }
};

Referenced by GSF_put_done_(), and GSF_put_init_().