GNUnet 0.25.0
 
Loading...
Searching...
No Matches
Data Structures | Macros | Functions
datacache.c File Reference

datacache API implementation More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_datacache_lib.h"
#include "gnunet_statistics_service.h"
#include "gnunet_datacache_plugin.h"
Include dependency graph for datacache.c:

Go to the source code of this file.

Data Structures

struct  GNUNET_DATACACHE_Handle
 Internal state of the datacache library. More...
 

Macros

#define LOG(kind, ...)   GNUNET_log_from (kind, "datacache", __VA_ARGS__)
 
#define LOG_STRERROR_FILE(kind, op, fn)    GNUNET_log_from_strerror_file (kind, "datacache", op, fn)
 

Functions

static void env_delete_notify (void *cls, const struct GNUNET_HashCode *key, size_t size)
 Function called by plugins to notify the datacache about content deletions.
 
struct GNUNET_DATACACHE_Handle * GNUNET_DATACACHE_create (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section)
 Create a data cache.
 
void GNUNET_DATACACHE_destroy (struct GNUNET_DATACACHE_Handle *h)
 Destroy a data cache (and free associated resources).
 
enum GNUNET_GenericReturnValue GNUNET_DATACACHE_put (struct GNUNET_DATACACHE_Handle *h, uint32_t xor_distance, const struct GNUNET_DATACACHE_Block *block)
 Store an item in the datacache.
 
unsigned int GNUNET_DATACACHE_get (struct GNUNET_DATACACHE_Handle *h, const struct GNUNET_HashCode *key, enum GNUNET_BLOCK_Type type, GNUNET_DATACACHE_Iterator iter, void *iter_cls)
 Iterate over the results for a particular key in the datacache.
 
unsigned int GNUNET_DATACACHE_get_closest (struct GNUNET_DATACACHE_Handle *h, const struct GNUNET_HashCode *key, enum GNUNET_BLOCK_Type type, unsigned int num_results, GNUNET_DATACACHE_Iterator iter, void *iter_cls)
 Iterate over the results that are "close" to a particular key in the datacache.
 

Detailed Description

datacache API implementation

Author
Christian Grothoff

Definition in file datacache.c.

Macro Definition Documentation

◆ LOG

#define LOG (   kind,
  ... 
)    GNUNET_log_from (kind, "datacache", __VA_ARGS__)

Definition at line 32 of file datacache.c.

◆ LOG_STRERROR_FILE

#define LOG_STRERROR_FILE (   kind,
  op,
  fn 
)     GNUNET_log_from_strerror_file (kind, "datacache", op, fn)

Definition at line 34 of file datacache.c.

40{
44 struct GNUNET_CONTAINER_BloomFilter *filter;
45
49 const struct GNUNET_CONFIGURATION_Handle *cfg;
50
54 struct GNUNET_STATISTICS_Handle *stats;
55
59 char *section;
60
65 struct GNUNET_DATACACHE_PluginFunctions *api;
66
70 char *short_name;
71
75 char *lib_name;
76
80 char *bloom_name;
81
85 struct GNUNET_DATACACHE_PluginEnvironment env;
86
90 unsigned long long utilization;
91};
92
93
102static void
103env_delete_notify (void *cls,
104 const struct GNUNET_HashCode *key,
105 size_t size)
106{
107 struct GNUNET_DATACACHE_Handle *h = cls;
108
109 LOG (GNUNET_ERROR_TYPE_DEBUG,
110 "Content under key `%s' discarded\n",
111 GNUNET_h2s (key));
112 GNUNET_assert (h->utilization >= size);
113 h->utilization -= size;
114 GNUNET_CONTAINER_bloomfilter_remove (h->filter, key);
115 GNUNET_STATISTICS_update (h->stats,
116 "# bytes stored",
117 -(long long) size,
118 GNUNET_NO);
119 GNUNET_STATISTICS_update (h->stats,
120 "# items stored",
121 -1,
122 GNUNET_NO);
123}
124
125
126struct GNUNET_DATACACHE_Handle *
127GNUNET_DATACACHE_create (const struct GNUNET_CONFIGURATION_Handle *cfg,
128 const char *section)
129{
130 unsigned int bf_size;
131 unsigned long long quota;
132 struct GNUNET_DATACACHE_Handle *ret;
133 char *libname;
134 char *name;
135
136 if (GNUNET_OK !=
137 GNUNET_CONFIGURATION_get_value_size (cfg,
138 section,
139 "QUOTA",
140 &quota))
141 {
142 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
143 section,
144 "QUOTA");
145 return NULL;
146 }
147 if (GNUNET_OK !=
148 GNUNET_CONFIGURATION_get_value_string (cfg,
149 section,
150 "DATABASE",
151 &name))
152 {
153 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
154 section,
155 "DATABASE");
156 return NULL;
157 }
158 bf_size = quota / 32; /* 8 bit per entry, 1 bit per 32 kb in DB */
159
160 ret = GNUNET_new (struct GNUNET_DATACACHE_Handle);
161
162 if (GNUNET_YES !=
163 GNUNET_CONFIGURATION_get_value_yesno (cfg,
164 section,
165 "DISABLE_BF"))
166 {
167 if (GNUNET_YES !=
168 GNUNET_CONFIGURATION_get_value_yesno (cfg,
169 section,
170 "DISABLE_BF_RC"))
171 {
172 ret->bloom_name = GNUNET_DISK_mktemp ("gnunet-datacachebloom");
173 }
174 if (NULL != ret->bloom_name)
175 {
176 ret->filter = GNUNET_CONTAINER_bloomfilter_load (
177 ret->bloom_name,
178 quota / 1024, /* 8 bit per entry in DB, expect 1k entries */
179 5);
180 }
181 if (NULL == ret->filter)
182 {
183 ret->filter =
184 GNUNET_CONTAINER_bloomfilter_init (NULL,
185 bf_size,
186 5); /* approx. 3% false positives at max use */
187 }
188 }
189 ret->stats = GNUNET_STATISTICS_create ("datacache",
190 cfg);
191 ret->section = GNUNET_strdup (section);
192 ret->env.cfg = cfg;
193 ret->env.delete_notify = &env_delete_notify;
194 ret->env.section = ret->section;
195 ret->env.cls = ret;
196 ret->env.delete_notify = &env_delete_notify;
197 ret->env.quota = quota;
198 LOG (GNUNET_ERROR_TYPE_INFO,
199 "Loading `%s' datacache plugin\n",
200 name);
201 GNUNET_asprintf (&libname,
202 "libgnunet_plugin_datacache_%s",
203 name);
204 ret->short_name = name;
205 ret->lib_name = libname;
206 /* Load the plugin within GNUnet's default context */
207 ret->api = GNUNET_PLUGIN_load (GNUNET_CONFIGURATION_get_project_data (cfg),
208 libname,
209 &ret->env);
210 if (NULL == ret->api)
211 {
212 LOG (GNUNET_ERROR_TYPE_ERROR,
213 "Failed to load datacache plugin for `%s'\n",
214 name);
215 GNUNET_DATACACHE_destroy (ret);
216 return NULL;
217 }
218 return ret;
219}
220
221
222void
223GNUNET_DATACACHE_destroy (struct GNUNET_DATACACHE_Handle *h)
224{
225 if (NULL != h->filter)
226 GNUNET_CONTAINER_bloomfilter_free (h->filter);
227 if (NULL != h->api)
228 GNUNET_break (NULL ==
229 GNUNET_PLUGIN_unload (h->lib_name,
230 h->api));
231 GNUNET_free (h->lib_name);
232 GNUNET_free (h->short_name);
233 GNUNET_free (h->section);
234 if (NULL != h->bloom_name)
235 {
236 if (0 != unlink (h->bloom_name))
237 GNUNET_log_from_strerror_file (GNUNET_ERROR_TYPE_WARNING,
238 "datacache",
239 "unlink",
240 h->bloom_name);
241 GNUNET_free (h->bloom_name);
242 }
243 GNUNET_STATISTICS_destroy (h->stats, GNUNET_NO);
244 GNUNET_free (h);
245}
246
247
248enum GNUNET_GenericReturnValue
249GNUNET_DATACACHE_put (struct GNUNET_DATACACHE_Handle *h,
250 uint32_t xor_distance,
251 const struct GNUNET_DATACACHE_Block *block)
252{
253 ssize_t used;
254
255 used = h->api->put (h->api->cls,
256 xor_distance,
257 block);
258 if (-1 == used)
259 {
260 GNUNET_break (0);
261 return GNUNET_SYSERR;
262 }
263 if (0 == used)
264 {
265 /* duplicate */
266 return GNUNET_NO;
267 }
268 LOG (GNUNET_ERROR_TYPE_DEBUG,
269 "Stored data under key `%s' in cache\n",
270 GNUNET_h2s (&block->key));
271 if (NULL != h->filter)
272 GNUNET_CONTAINER_bloomfilter_add (h->filter,
273 &block->key);
274 GNUNET_STATISTICS_update (h->stats,
275 "# bytes stored",
276 used,
277 GNUNET_NO);
278 GNUNET_STATISTICS_update (h->stats,
279 "# items stored",
280 1,
281 GNUNET_NO);
282 while (h->utilization + used > h->env.quota)
283 GNUNET_assert (GNUNET_OK ==
284 h->api->del (h->api->cls));
285 h->utilization += used;
286 return GNUNET_OK;
287}
288
289
290unsigned int
291GNUNET_DATACACHE_get (struct GNUNET_DATACACHE_Handle *h,
292 const struct GNUNET_HashCode *key,
293 enum GNUNET_BLOCK_Type type,
294 GNUNET_DATACACHE_Iterator iter,
295 void *iter_cls)
296{
297 GNUNET_STATISTICS_update (h->stats,
298 "# requests received",
299 1,
300 GNUNET_NO);
301 LOG (GNUNET_ERROR_TYPE_DEBUG,
302 "Processing request for key `%s'\n",
303 GNUNET_h2s (key));
304 if ( (NULL != h->filter) &&
305 (GNUNET_OK !=
306 GNUNET_CONTAINER_bloomfilter_test (h->filter,
307 key)) )
308 {
309 GNUNET_STATISTICS_update (h->stats,
310 "# requests filtered by bloom filter",
311 1,
312 GNUNET_NO);
313 LOG (GNUNET_ERROR_TYPE_DEBUG,
314 "Bloomfilter filters request for key `%s'\n",
315 GNUNET_h2s (key));
316 return 0; /* can not be present */
317 }
318 return h->api->get (h->api->cls,
319 key,
320 type,
321 iter, iter_cls);
322}
323
324
325unsigned int
326GNUNET_DATACACHE_get_closest (struct GNUNET_DATACACHE_Handle *h,
327 const struct GNUNET_HashCode *key,
328 enum GNUNET_BLOCK_Type type,
329 unsigned int num_results,
330 GNUNET_DATACACHE_Iterator iter,
331 void *iter_cls)
332{
333 GNUNET_STATISTICS_update (h->stats,
334 "# proximity search requests received",
335 1,
336 GNUNET_NO);
337 LOG (GNUNET_ERROR_TYPE_DEBUG,
338 "Processing proximity search at `%s'\n",
339 GNUNET_h2s (key));
340 return h->api->get_closest (h->api->cls,
341 key,
342 type,
343 num_results,
344 iter,
345 iter_cls);
346}
347
348
349/* end of datacache.c */
env
struct GNUNET_MQ_Envelope * env
Definition 005.c:1
env_delete_notify
static void env_delete_notify(void *cls, const struct GNUNET_HashCode *key, size_t size)
Function called by plugins to notify the datacache about content deletions.
Definition datacache.c:104
LOG
#define LOG(kind,...)
Definition datacache.c:32
h
static struct GNUNET_ARM_Handle * h
Connection with ARM.
Definition gnunet-arm.c:98
ret
static int ret
Final status code.
Definition gnunet-arm.c:93
cfg
static struct GNUNET_CONFIGURATION_Handle * cfg
Our configuration.
Definition gnunet-arm.c:108
key
struct GNUNET_HashCode key
The key used in the DHT.
Definition gnunet-dht-put.c:37
name
static char * name
Name (label) of the records to list.
Definition gnunet-namecache.c:48
type
static uint32_t type
Type string converted to DNS type value.
Definition gnunet-namestore.c:306
filter
static struct GNUNET_CONTAINER_BloomFilter * filter
Bloomfilter to quickly tell if we don't have the content.
Definition gnunet-service-datastore.c:149
quota
static unsigned long long quota
How much space are we allowed to use?
Definition gnunet-service-datastore.c:202
stats
static struct GNUNET_STATISTICS_Handle * stats
Handle to the statistics service.
Definition gnunet-zoneimport.c:270
GNUNET_BLOCK_Type
GNUNET_BLOCK_Type
WARNING: This header is generated! In order to add DHT block types, you must register them in GANA,...
Definition gnunet_dht_block_types.h:43
GNUNET_CONTAINER_bloomfilter_init
struct GNUNET_CONTAINER_BloomFilter * GNUNET_CONTAINER_bloomfilter_init(const char *data, size_t size, unsigned int k)
Create a Bloom filter from raw bits.
Definition container_bloomfilter.c:613
GNUNET_CONTAINER_bloomfilter_add
void GNUNET_CONTAINER_bloomfilter_add(struct GNUNET_CONTAINER_BloomFilter *bf, const struct GNUNET_HashCode *e)
Add an element to the filter.
Definition container_bloomfilter.c:697
GNUNET_CONTAINER_bloomfilter_test
bool GNUNET_CONTAINER_bloomfilter_test(const struct GNUNET_CONTAINER_BloomFilter *bf, const struct GNUNET_HashCode *e)
Test if an element is in the filter.
Definition container_bloomfilter.c:679
GNUNET_CONTAINER_bloomfilter_load
struct GNUNET_CONTAINER_BloomFilter * GNUNET_CONTAINER_bloomfilter_load(const char *filename, size_t size, unsigned int k)
Load a Bloom filter from a file.
Definition container_bloomfilter.c:472
GNUNET_CONTAINER_bloomfilter_remove
void GNUNET_CONTAINER_bloomfilter_remove(struct GNUNET_CONTAINER_BloomFilter *bf, const struct GNUNET_HashCode *e)
Remove an element from the filter.
Definition container_bloomfilter.c:767
GNUNET_CONTAINER_bloomfilter_free
void GNUNET_CONTAINER_bloomfilter_free(struct GNUNET_CONTAINER_BloomFilter *bf)
Free the space associated with a filter in memory, flush to drive if needed (do not free the space on...
Definition container_bloomfilter.c:654
GNUNET_CONFIGURATION_get_value_size
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_value_size(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, unsigned long long *size)
Get a configuration value that should be a size in bytes.
Definition configuration.c:1891
GNUNET_CONFIGURATION_get_value_yesno
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_value_yesno(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option)
Get a configuration value that should be in a set of "YES" or "NO".
Definition configuration.c:2256
GNUNET_CONFIGURATION_get_value_string
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_value_string(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, char **value)
Get a configuration value that should be a string.
Definition configuration.c:1921
GNUNET_CONFIGURATION_get_project_data
const struct GNUNET_OS_ProjectData * GNUNET_CONFIGURATION_get_project_data(const struct GNUNET_CONFIGURATION_Handle *cfg)
Return the project data associated with this configuration.
Definition configuration.c:3004
GNUNET_DATACACHE_get
unsigned int GNUNET_DATACACHE_get(struct GNUNET_DATACACHE_Handle *h, const struct GNUNET_HashCode *key, enum GNUNET_BLOCK_Type type, GNUNET_DATACACHE_Iterator iter, void *iter_cls)
Iterate over the results for a particular key in the datacache.
Definition datacache.c:292
GNUNET_DATACACHE_put
enum GNUNET_GenericReturnValue GNUNET_DATACACHE_put(struct GNUNET_DATACACHE_Handle *h, uint32_t xor_distance, const struct GNUNET_DATACACHE_Block *block)
Store an item in the datacache.
Definition datacache.c:250
GNUNET_DATACACHE_create
struct GNUNET_DATACACHE_Handle * GNUNET_DATACACHE_create(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section)
Create a data cache.
Definition datacache.c:128
GNUNET_DATACACHE_Iterator
enum GNUNET_GenericReturnValue(* GNUNET_DATACACHE_Iterator)(void *cls, const struct GNUNET_DATACACHE_Block *block)
An iterator over a set of items stored in the datacache.
Definition gnunet_datacache_lib.h:145
GNUNET_DATACACHE_destroy
void GNUNET_DATACACHE_destroy(struct GNUNET_DATACACHE_Handle *h)
Destroy a data cache (and free associated resources).
Definition datacache.c:224
GNUNET_DATACACHE_get_closest
unsigned int GNUNET_DATACACHE_get_closest(struct GNUNET_DATACACHE_Handle *h, const struct GNUNET_HashCode *key, enum GNUNET_BLOCK_Type type, unsigned int num_results, GNUNET_DATACACHE_Iterator iter, void *iter_cls)
Iterate over the results that are "close" to a particular key in the datacache.
Definition datacache.c:327
GNUNET_DISK_mktemp
char * GNUNET_DISK_mktemp(const char *t)
Create an (empty) temporary file on disk.
Definition disk.c:431
GNUNET_GenericReturnValue
GNUNET_GenericReturnValue
Named constants for return values.
Definition gnunet_common.h:111
GNUNET_OK
@ GNUNET_OK
Definition gnunet_common.h:114
GNUNET_YES
@ GNUNET_YES
Definition gnunet_common.h:116
GNUNET_NO
@ GNUNET_NO
Definition gnunet_common.h:113
GNUNET_SYSERR
@ GNUNET_SYSERR
Definition gnunet_common.h:112
GNUNET_log_from_strerror_file
#define GNUNET_log_from_strerror_file(level, component, cmd, filename)
Log an error message at log-level 'level' that indicates a failure of the command 'cmd' with the mess...
Definition gnunet_common.h:1146
GNUNET_assert
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
Definition gnunet_common.h:960
GNUNET_break
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur.
Definition gnunet_common.h:1045
GNUNET_h2s
const char * GNUNET_h2s(const struct GNUNET_HashCode *hc)
Convert a hash value to a string (for printing debug messages).
Definition common_logging.c:1166
GNUNET_log_config_missing
void GNUNET_log_config_missing(enum GNUNET_ErrorType kind, const char *section, const char *option)
Log error message about missing configuration option.
Definition common_logging.c:1451
GNUNET_ERROR_TYPE_WARNING
@ GNUNET_ERROR_TYPE_WARNING
Definition gnunet_common.h:418
GNUNET_ERROR_TYPE_ERROR
@ GNUNET_ERROR_TYPE_ERROR
Definition gnunet_common.h:417
GNUNET_ERROR_TYPE_DEBUG
@ GNUNET_ERROR_TYPE_DEBUG
Definition gnunet_common.h:424
GNUNET_ERROR_TYPE_INFO
@ GNUNET_ERROR_TYPE_INFO
Definition gnunet_common.h:423
GNUNET_asprintf
int int GNUNET_asprintf(char **buf, const char *format,...) __attribute__((format(printf
Like asprintf, just portable.
GNUNET_strdup
#define GNUNET_strdup(a)
Wrapper around GNUNET_xstrdup_.
Definition gnunet_common.h:1429
GNUNET_new
#define GNUNET_new(type)
Allocate a struct or union of the given type.
Definition gnunet_common.h:1240
GNUNET_free
#define GNUNET_free(ptr)
Wrapper around free.
Definition gnunet_common.h:1415
GNUNET_PLUGIN_load
void * GNUNET_PLUGIN_load(const struct GNUNET_OS_ProjectData *pd, const char *library_name, void *arg)
Setup plugin (runs the "init" callback and returns whatever "init" returned).
Definition plugin.c:221
GNUNET_PLUGIN_unload
void * GNUNET_PLUGIN_unload(const char *library_name, void *arg)
Unload plugin (runs the "done" callback and returns whatever "done" returned).
Definition plugin.c:277
GNUNET_STATISTICS_create
struct GNUNET_STATISTICS_Handle * GNUNET_STATISTICS_create(const char *subsystem, const struct GNUNET_CONFIGURATION_Handle *cfg)
Get handle for the statistics service.
Definition statistics_api.c:889
GNUNET_STATISTICS_update
void GNUNET_STATISTICS_update(struct GNUNET_STATISTICS_Handle *handle, const char *name, int64_t delta, int make_persistent)
Set statistic value for the peer.
Definition statistics_api.c:1324
GNUNET_STATISTICS_destroy
void GNUNET_STATISTICS_destroy(struct GNUNET_STATISTICS_Handle *h, int sync_first)
Destroy a handle (free all state associated with it).
Definition statistics_api.c:916
size
static unsigned int size
Size of the "table".
Definition peer.c:68
GNUNET_CONFIGURATION_Handle
configuration data
Definition configuration.c:149
GNUNET_CONTAINER_BloomFilter
Definition container_bloomfilter.c:59
GNUNET_DATACACHE_Block
Information about a block stored in the datacache.
Definition gnunet_datacache_lib.h:61
GNUNET_DATACACHE_Block::key
struct GNUNET_HashCode key
Key of the block.
Definition gnunet_datacache_lib.h:65
GNUNET_DATACACHE_Handle
Internal state of the datacache library.
Definition datacache.c:41
GNUNET_DATACACHE_Handle::section
char * section
Configuration section to use.
Definition datacache.c:60
GNUNET_DATACACHE_PluginEnvironment
The datastore service will pass a pointer to a struct of this type as the first and only argument to ...
Definition gnunet_datacache_plugin.h:69
GNUNET_DATACACHE_PluginEnvironment::cls
void * cls
Closure to use for callbacks.
Definition gnunet_datacache_plugin.h:83
GNUNET_DATACACHE_PluginFunctions
struct returned by the initialization function of the plugin
Definition gnunet_datacache_plugin.h:102
GNUNET_HashCode
A 512-bit hashcode.
Definition gnunet_common.h:287
GNUNET_STATISTICS_Handle
Handle for the service.
Definition statistics_api.c:178

Function Documentation

◆ env_delete_notify()

static void env_delete_notify ( void *  cls,
const struct GNUNET_HashCode *  key,
size_t  size 
)
static

Function called by plugins to notify the datacache about content deletions.

Parameters
clsclosure
keykey of the content that was deleted
sizenumber of bytes that were made available

Definition at line 104 of file datacache.c.

107{
108 struct GNUNET_DATACACHE_Handle *h = cls;
109
110 LOG (GNUNET_ERROR_TYPE_DEBUG,
111 "Content under key `%s' discarded\n",
112 GNUNET_h2s (key));
113 GNUNET_assert (h->utilization >= size);
114 h->utilization -= size;
115 GNUNET_CONTAINER_bloomfilter_remove (h->filter, key);
116 GNUNET_STATISTICS_update (h->stats,
117 "# bytes stored",
118 -(long long) size,
119 GNUNET_NO);
120 GNUNET_STATISTICS_update (h->stats,
121 "# items stored",
122 -1,
123 GNUNET_NO);
124}

References GNUNET_assert, GNUNET_CONTAINER_bloomfilter_remove(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_h2s(), GNUNET_NO, GNUNET_STATISTICS_update(), h, key, LOG, and size.

Referenced by GNUNET_DATACACHE_create().

Here is the call graph for this function:
Here is the caller graph for this function: