gnunet-service-fs.h File Reference

shared data structures of gnunet-service-fs.c More...

#include "gnunet_util_lib.h"
#include "gnunet_statistics_service.h"
#include "gnunet_core_service.h"
#include "gnunet_block_lib.h"
#include "fs.h"

Include dependency graph for gnunet-service-fs.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	GetMessage
	Message to the datastore service asking about specific content. More...
struct	MigrationStopMessage
	Message send by a peer that wants to be excluded from migration for a while. More...

Macros
#define	TTL_DECREMENT   5000
	By which amount do we decrement the TTL for simple forwarding / indirection of the query; in milli-seconds.
#define	DATASTORE_LOAD_AUTODECLINE
	At what frequency should our datastore load decrease automatically (since if we don't use it, clearly the load must be going down).
#define	GET_MESSAGE_BIT_QUERY_ONLY   0
	Only the (mandatory) query is included.
#define	GET_MESSAGE_BIT_RETURN_TO   1
	The peer identity of a peer waiting for the reply is included (used if the response should be transmitted to someone other than the sender of the GET).
#define	GET_MESSAGE_BIT_TRANSMIT_TO   4
	The peer identity of a peer that had claimed to have the content previously is included (can be used if responder-anonymity is not desired; note that the precursor presumably lacked a direct connection to the specified peer; still, the receiver is in no way required to limit forwarding only to the specified peer, it should only prefer it somewhat if possible).

Functions
void	GSF_consider_forwarding (void *cls, struct GSF_PendingRequest *pr, enum GNUNET_BLOCK_ReplyEvaluationResult result)
	Function to be called after we're done processing replies from the local lookup.
int	GSF_test_get_load_too_high_ (uint32_t priority)
	Test if the DATABASE (GET) load on this peer is too high to even consider processing the query at all.
void	GSF_update_datastore_delay_ (struct GNUNET_TIME_Absolute start)
	We've just now completed a datastore request.

Variables
struct GNUNET_DATASTORE_Handle *	GSF_dsh
	Our connection to the datastore.
const struct GNUNET_CONFIGURATION_Handle *	GSF_cfg
	Our configuration.
struct GNUNET_STATISTICS_Handle *	GSF_stats
	Handle for reporting statistics.
struct GNUNET_CORE_Handle *	GSF_core
	Pointer to handle to the core service (points to NULL until we've connected to it).
struct GNUNET_DHT_Handle *	GSF_dht
	Handle for DHT operations.
struct GNUNET_LOAD_Value *	GSF_rt_entry_lifetime
	How long do requests typically stay in the routing table?
struct GNUNET_TIME_Relative	GSF_avg_latency
	Running average of the observed latency to other peers (round trip).
struct GNUNET_ATS_PerformanceHandle *	GSF_ats
	Handle to ATS service.
struct GNUNET_PeerIdentity	GSF_my_id
	Identity of this peer.
double	GSF_current_priorities
	Typical priorities we're seeing from other peers right now.
unsigned int	GSF_cover_query_count
	How many query messages have we received 'recently' that have not yet been claimed as cover traffic?
unsigned int	GSF_cover_content_count
	How many content messages have we received 'recently' that have not yet been claimed as cover traffic?
struct GNUNET_BLOCK_Context *	GSF_block_ctx
	Our block context.
int	GSF_enable_randomized_delays
	Are we introducing randomized delays for better anonymity?
unsigned int	GSF_datastore_queue_size
	Size of the datastore queue we assume for common requests.

Detailed Description

shared data structures of gnunet-service-fs.c

Author

Christian Grothoff

Definition in file gnunet-service-fs.h.

Macro Definition Documentation

TTL_DECREMENT

#define TTL_DECREMENT   5000

By which amount do we decrement the TTL for simple forwarding / indirection of the query; in milli-seconds.

Set somewhat in accordance to your network latency (above the time it'll take you to send a packet and get a reply).

Definition at line 42 of file gnunet-service-fs.h.

DATASTORE_LOAD_AUTODECLINE

#define DATASTORE_LOAD_AUTODECLINE

Value:

    GNUNET_TIME_relative_multiply ( \
    GNUNET_TIME_UNIT_MILLISECONDS, 250)

At what frequency should our datastore load decrease automatically (since if we don't use it, clearly the load must be going down).

Definition at line 49 of file gnunet-service-fs.h.

{
  struct GNUNET_MessageHeader header;
 
  uint32_t type GNUNET_PACKED;
 
  uint32_t priority GNUNET_PACKED;
 
  int32_t ttl GNUNET_PACKED;
 
  uint32_t reserved GNUNET_PACKED;
 
  uint32_t hash_bitmap GNUNET_PACKED;
 
  struct GNUNET_HashCode query;
 
  /* this is followed by PeerIdentities as specified in the "hash_bitmap";
   * after that, an optional bloomfilter (with bits set for replies
   * that should be suppressed) can be present */
};
 
 
struct MigrationStopMessage
{
  struct GNUNET_MessageHeader header;
 
  uint32_t reserved GNUNET_PACKED;
 
  struct GNUNET_TIME_RelativeNBO duration;
};
GNUNET_NETWORK_STRUCT_END
 
struct GSF_ConnectedPeer;
 
struct GSF_PendingRequest;
 
struct GSF_LocalClient;
 
struct GSF_RequestPlan;
 
struct GSF_PendingRequestPlanBijection;
 
extern struct GNUNET_DATASTORE_Handle *GSF_dsh;
 
extern const struct GNUNET_CONFIGURATION_Handle *GSF_cfg;
 
extern struct GNUNET_STATISTICS_Handle *GSF_stats;
 
extern struct GNUNET_CORE_Handle *GSF_core;
 
extern struct GNUNET_DHT_Handle *GSF_dht;
 
extern struct GNUNET_LOAD_Value *GSF_rt_entry_lifetime;
 
extern struct GNUNET_TIME_Relative GSF_avg_latency;
 
extern struct GNUNET_ATS_PerformanceHandle *GSF_ats;
 
extern struct GNUNET_PeerIdentity GSF_my_id;
 
extern double GSF_current_priorities;
 
extern unsigned int GSF_cover_query_count;
 
extern unsigned int GSF_cover_content_count;
 
extern struct GNUNET_BLOCK_Context *GSF_block_ctx;
 
extern int GSF_enable_randomized_delays;
 
extern unsigned int GSF_datastore_queue_size;
 
 
void
GSF_consider_forwarding (void *cls,
                         struct GSF_PendingRequest *pr,
                         enum GNUNET_BLOCK_ReplyEvaluationResult result);
 
 
int
GSF_test_get_load_too_high_ (uint32_t priority);
 
 
void
GSF_update_datastore_delay_ (struct GNUNET_TIME_Absolute start);
 
 
#endif
/* end of gnunet-service-fs.h */

GET_MESSAGE_BIT_QUERY_ONLY

#define GET_MESSAGE_BIT_QUERY_ONLY   0

Only the (mandatory) query is included.

Definition at line 55 of file gnunet-service-fs.h.

GET_MESSAGE_BIT_RETURN_TO

#define GET_MESSAGE_BIT_RETURN_TO   1

The peer identity of a peer waiting for the reply is included (used if the response should be transmitted to someone other than the sender of the GET).

Definition at line 63 of file gnunet-service-fs.h.

GET_MESSAGE_BIT_TRANSMIT_TO

#define GET_MESSAGE_BIT_TRANSMIT_TO   4

The peer identity of a peer that had claimed to have the content previously is included (can be used if responder-anonymity is not desired; note that the precursor presumably lacked a direct connection to the specified peer; still, the receiver is in no way required to limit forwarding only to the specified peer, it should only prefer it somewhat if possible).

Definition at line 73 of file gnunet-service-fs.h.

Function Documentation

GSF_consider_forwarding()

void GSF_consider_forwarding	(	void *	cls,
		struct GSF_PendingRequest *	pr,
		enum GNUNET_BLOCK_ReplyEvaluationResult	result
	)

Function to be called after we're done processing replies from the local lookup.

If the result status code indicates that there may be more replies, plan forwarding the request.

Parameters

cls	closure (NULL)
pr	the pending request we were processing
result	final datastore lookup result

Definition at line 629 of file gnunet-service-fs.c.

{
  if (GNUNET_BLOCK_REPLY_OK_LAST == result)
    return;                     /* we're done... */
  if (GNUNET_YES !=
      GSF_pending_request_test_active_ (pr))
    return; /* request is not actually active, skip! */
  GSF_iterate_connected_peers_ (&consider_request_for_forwarding,
                                pr);
}

References consider_request_for_forwarding(), GNUNET_BLOCK_REPLY_OK_LAST, GNUNET_YES, GSF_iterate_connected_peers_(), GSF_pending_request_test_active_(), and result.

Referenced by handle_p2p_get(), and start_p2p_processing().

Here is the call graph for this function:

Here is the caller graph for this function:

GSF_test_get_load_too_high_()

int GSF_test_get_load_too_high_

(

uint32_t

priority

)

Test if the DATABASE (GET) load on this peer is too high to even consider processing the query at all.

Returns

GNUNET_YES if the load is too high to do anything (load high) GNUNET_NO to process normally (load normal) GNUNET_SYSERR to process for free (load low)

Parameters

priority

priority of the request (used as a reference point to compare with the load)

Returns

GNUNET_YES if the load is too high to do anything (load high) GNUNET_NO to process normally (load normal) GNUNET_SYSERR to process for free (load low)

Definition at line 549 of file gnunet-service-fs.c.

{
  double ld;
 
  ld = GNUNET_LOAD_get_load (datastore_get_load);
  if (ld < 1)
    return GNUNET_SYSERR;
  if (ld <= priority)
    return GNUNET_NO;
  return GNUNET_YES;
}

References datastore_get_load, GNUNET_LOAD_get_load(), GNUNET_NO, GNUNET_SYSERR, and GNUNET_YES.

Referenced by bound_priority(), and process_local_reply().

Here is the call graph for this function:

Here is the caller graph for this function:

GSF_update_datastore_delay_()

void GSF_update_datastore_delay_

(

struct GNUNET_TIME_Absolute

start

)

We've just now completed a datastore request.

Update our datastore load calculations.

Parameters

start

time when the datastore request was issued

Definition at line 529 of file gnunet-service-fs.c.

{
  struct GNUNET_TIME_Relative delay;
 
  delay = GNUNET_TIME_absolute_get_duration (start);
  GNUNET_LOAD_update (datastore_get_load, delay.rel_value_us);
}

References datastore_get_load, GNUNET_LOAD_update(), GNUNET_TIME_absolute_get_duration(), GNUNET_TIME_Relative::rel_value_us, and start.

Referenced by process_local_reply().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

GSF_dsh

struct GNUNET_DATASTORE_Handle* GSF_dsh

extern

Our connection to the datastore.

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

Referenced by consider_gathering(), gather_dht_put_blocks(), gather_migration_blocks(), handle_dht_reply(), handle_p2p_put(), handle_request(), process_local_reply(), run(), shutdown_task(), and start_local_query().

GSF_cfg

const struct GNUNET_CONFIGURATION_Handle* GSF_cfg

extern

Our configuration.

Definition at line 227 of file gnunet-service-fs.c.

Referenced by GSF_cadet_start_server(), GSF_connected_peer_init_(), GSF_pending_request_init_(), GSF_push_init_(), main_init(), and run().

GSF_stats

struct GNUNET_STATISTICS_Handle* GSF_stats

extern

Handle for reporting statistics.

Definition at line 232 of file gnunet-service-fs.c.

Referenced by bound_priority(), cadet_reply_proc(), clean_request(), client_request_destroy(), client_response_handler(), connect_cb(), consider_peer_for_forwarding(), consider_request_for_forwarding(), disconnect_cb(), free_pending_request(), get_randomized_delay(), GNUNET_FS_handle_on_demand_block(), GSF_block_peer_migration_(), GSF_local_lookup_(), GSF_peer_connect_handler(), GSF_peer_disconnect_handler(), GSF_pending_request_create_(), GSF_plan_add_(), GSF_plan_notify_peer_disconnect_(), GSF_plan_notify_request_done_(), handle_client_start_search(), handle_datastore_reply(), handle_dht_reply(), handle_p2p_get(), handle_p2p_migration_stop(), handle_p2p_put(), handle_p2p_reply(), handle_reply(), handle_request(), merge_pr(), no_more_local_results(), plan(), process_local_reply(), process_reply(), put_migration_continuation(), run(), schedule_peer_transmission(), shutdown_task(), start_local_query(), test_exist_cb(), and test_put_load_too_high().

GSF_core

struct GNUNET_CORE_Handle* GSF_core

extern

Pointer to handle to the core service (points to NULL until we've connected to it).

Definition at line 289 of file gnunet-service-fs.c.

Referenced by main_init(), and shutdown_task().

GSF_dht

struct GNUNET_DHT_Handle* GSF_dht

extern

Handle for DHT operations.

Definition at line 237 of file gnunet-service-fs.c.

Referenced by GSF_dht_lookup_(), process_dht_put_content(), run(), and shutdown_task().

GSF_rt_entry_lifetime

struct GNUNET_LOAD_Value* GSF_rt_entry_lifetime

extern

How long do requests typically stay in the routing table?

Definition at line 242 of file gnunet-service-fs.c.

Referenced by handle_p2p_get(), process_reply(), run(), and shutdown_task().

GSF_avg_latency

struct GNUNET_TIME_Relative GSF_avg_latency

extern

Running average of the observed latency to other peers (round trip).

Initialized to 5s as the initial default.

Definition at line 248 of file gnunet-service-fs.c.

{ 500 };

Referenced by get_randomized_delay().

GSF_ats

struct GNUNET_ATS_PerformanceHandle* GSF_ats

extern

Handle to ATS service.

GSF_my_id

struct GNUNET_PeerIdentity GSF_my_id

extern

Identity of this peer.

Definition at line 305 of file gnunet-service-fs.c.

Referenced by GSF_peer_connect_handler(), main_init(), and pils_pid_change_cb().

GSF_current_priorities

double GSF_current_priorities

extern

Typical priorities we're seeing from other peers right now.

Since most priorities will be zero, this value is the weighted average of non-zero priorities seen "recently". In order to ensure that new values do not dramatically change the ratio, values are first "capped" to a reasonable range (+N of the current value) and then averaged into the existing value by a ratio of 1:N. Hence receiving the largest possible priority can still only raise our "current_priorities" by at most 1.

Definition at line 261 of file gnunet-service-fs.c.

Referenced by bound_priority(), and plan().

GSF_cover_query_count

unsigned int GSF_cover_query_count

extern

How many query messages have we received 'recently' that have not yet been claimed as cover traffic?

Definition at line 272 of file gnunet-service-fs.c.

Referenced by age_cover_counters(), and handle_p2p_get().

GSF_cover_content_count

unsigned int GSF_cover_content_count

extern

How many content messages have we received 'recently' that have not yet been claimed as cover traffic?

Definition at line 278 of file gnunet-service-fs.c.

Referenced by age_cover_counters(), handle_p2p_put(), and handle_p2p_reply().

GSF_block_ctx

struct GNUNET_BLOCK_Context* GSF_block_ctx

extern

Our block context.

Definition at line 283 of file gnunet-service-fs.c.

Referenced by cadet_reply_proc(), GSF_pending_request_create_(), handle_p2p_put(), handle_reply(), process_local_reply(), process_reply(), refresh_bloomfilter(), run(), and shutdown_task().

GSF_enable_randomized_delays

int GSF_enable_randomized_delays

extern

Are we introducing randomized delays for better anonymity?

Definition at line 300 of file gnunet-service-fs.c.

Referenced by handle_p2p_reply(), and run().

GSF_datastore_queue_size

unsigned int GSF_datastore_queue_size

extern

Size of the datastore queue we assume for common requests.

Definition at line 266 of file gnunet-service-fs.c.

Referenced by handle_request(), run(), and start_local_query().