GNUnet  0.11.x
datacache.c
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet
3  Copyright (C) 2004, 2005, 2006, 2007, 2009, 2010, 2015 GNUnet e.V.
4 
5  GNUnet is free software: you can redistribute it and/or modify it
6  under the terms of the GNU Affero General Public License as published
7  by the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
10  GNUnet is distributed in the hope that it will be useful, but
11  WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  Affero General Public License for more details.
14 
15  You should have received a copy of the GNU Affero General Public License
16  along with this program. If not, see <http://www.gnu.org/licenses/>.
17 
18  SPDX-License-Identifier: AGPL3.0-or-later
19  */
25 #include "platform.h"
26 #include "gnunet_util_lib.h"
27 #include "gnunet_datacache_lib.h"
30 
31 
32 #define LOG(kind, ...) GNUNET_log_from (kind, "datacache", __VA_ARGS__)
33 
34 #define LOG_STRERROR_FILE(kind, op, fn) \
35  GNUNET_log_from_strerror_file (kind, "datacache", op, fn)
36 
41 {
46 
51 
56 
60  char *section;
61 
67 
71  char *short_name;
72 
76  char *lib_name;
77 
81  char *bloom_name;
82 
87 
91  unsigned long long utilization;
92 };
93 
94 
103 static void
104 env_delete_notify (void *cls, const struct GNUNET_HashCode *key, size_t size)
105 {
106  struct GNUNET_DATACACHE_Handle *h = cls;
107 
109  "Content under key `%s' discarded\n",
110  GNUNET_h2s (key));
111  GNUNET_assert (h->utilization >= size);
112  h->utilization -= size;
115  gettext_noop ("# bytes stored"),
116  -(long long) size,
117  GNUNET_NO);
119  gettext_noop ("# items stored"),
120  -1,
121  GNUNET_NO);
122 }
123 
124 
134  const char *section)
135 {
136  unsigned int bf_size;
137  unsigned long long quota;
139  char *libname;
140  char *name;
141 
142  if (GNUNET_OK !=
143  GNUNET_CONFIGURATION_get_value_size (cfg, section, "QUOTA", &quota))
144  {
146  return NULL;
147  }
148  if (GNUNET_OK !=
149  GNUNET_CONFIGURATION_get_value_string (cfg, section, "DATABASE", &name))
150  {
151  GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, section, "DATABASE");
152  return NULL;
153  }
154  bf_size = quota / 32; /* 8 bit per entry, 1 bit per 32 kb in DB */
155 
156  ret = GNUNET_new (struct GNUNET_DATACACHE_Handle);
157 
158  if (GNUNET_YES !=
159  GNUNET_CONFIGURATION_get_value_yesno (cfg, section, "DISABLE_BF"))
160  {
161  if (GNUNET_YES !=
162  GNUNET_CONFIGURATION_get_value_yesno (cfg, section, "DISABLE_BF_RC"))
163  {
164  ret->bloom_name = GNUNET_DISK_mktemp ("gnunet-datacachebloom");
165  }
166  if (NULL != ret->bloom_name)
167  {
169  ret->bloom_name,
170  quota / 1024, /* 8 bit per entry in DB, expect 1k entries */
171  5);
172  }
173  if (NULL == ret->filter)
174  {
175  ret->filter =
177  bf_size,
178  5); /* approx. 3% false positives at max use */
179  }
180  }
181  ret->stats = GNUNET_STATISTICS_create ("datacache", cfg);
182  ret->section = GNUNET_strdup (section);
183  ret->env.cfg = cfg;
185  ret->env.section = ret->section;
186  ret->env.cls = ret;
188  ret->env.quota = quota;
189  LOG (GNUNET_ERROR_TYPE_INFO, _ ("Loading `%s' datacache plugin\n"), name);
190  GNUNET_asprintf (&libname, "libgnunet_plugin_datacache_%s", name);
191  ret->short_name = name;
192  ret->lib_name = libname;
193  ret->api = GNUNET_PLUGIN_load (libname, &ret->env);
194  if (ret->api == NULL)
195  {
197  _ ("Failed to load datacache plugin for `%s'\n"),
198  name);
200  return NULL;
201  }
202  return ret;
203 }
204 
205 
211 void
213 {
214  if (NULL != h->filter)
216  if (NULL != h->api)
217  GNUNET_break (NULL == GNUNET_PLUGIN_unload (h->lib_name, h->api));
218  GNUNET_free (h->lib_name);
219  GNUNET_free (h->short_name);
220  GNUNET_free (h->section);
221  if (NULL != h->bloom_name)
222  {
223  if (0 != unlink (h->bloom_name))
225  "datacache",
226  "unlink",
227  h->bloom_name);
228  GNUNET_free (h->bloom_name);
229  }
231  GNUNET_free (h);
232 }
233 
234 
249 int
251  const struct GNUNET_HashCode *key,
252  uint32_t xor_distance,
253  size_t data_size,
254  const char *data,
255  enum GNUNET_BLOCK_Type type,
256  struct GNUNET_TIME_Absolute discard_time,
257  unsigned int path_info_len,
258  const struct GNUNET_PeerIdentity *path_info)
259 {
260  ssize_t used;
261 
262  used = h->api->put (h->api->cls,
263  key,
264  xor_distance,
265  data_size,
266  data,
267  type,
268  discard_time,
269  path_info_len,
270  path_info);
271  if (-1 == used)
272  {
273  GNUNET_break (0);
274  return GNUNET_SYSERR;
275  }
276  if (0 == used)
277  {
278  /* duplicate */
279  return GNUNET_NO;
280  }
282  "Stored data under key `%s' in cache\n",
283  GNUNET_h2s (key));
284  if (NULL != h->filter)
287  gettext_noop ("# bytes stored"),
288  used,
289  GNUNET_NO);
291  gettext_noop ("# items stored"),
292  1,
293  GNUNET_NO);
294  while (h->utilization + used > h->env.quota)
295  GNUNET_assert (GNUNET_OK == h->api->del (h->api->cls));
296  h->utilization += used;
297  return GNUNET_OK;
298 }
299 
300 
312 unsigned int
314  const struct GNUNET_HashCode *key,
315  enum GNUNET_BLOCK_Type type,
317  void *iter_cls)
318 {
320  gettext_noop ("# requests received"),
321  1,
322  GNUNET_NO);
324  "Processing request for key `%s'\n",
325  GNUNET_h2s (key));
326  if ((NULL != h->filter) &&
328  {
330  gettext_noop (
331  "# requests filtered by bloom filter"),
332  1,
333  GNUNET_NO);
335  "Bloomfilter filters request for key `%s'\n",
336  GNUNET_h2s (key));
337  return 0; /* can not be present */
338  }
339  return h->api->get (h->api->cls, key, type, iter, iter_cls);
340 }
341 
342 
351 unsigned int
354  void *iter_cls)
355 {
357  gettext_noop (
358  "# requests for random value received"),
359  1,
360  GNUNET_NO);
361  LOG (GNUNET_ERROR_TYPE_DEBUG, "Processing request for random value\n");
362  return h->api->get_random (h->api->cls, iter, iter_cls);
363 }
364 
365 
379 unsigned int
381  const struct GNUNET_HashCode *key,
382  unsigned int num_results,
384  void *iter_cls)
385 {
387  gettext_noop (
388  "# proximity search requests received"),
389  1,
390  GNUNET_NO);
392  "Processing proximity search at `%s'\n",
393  GNUNET_h2s (key));
394  return h->api->get_closest (h->api->cls, key, num_results, iter, iter_cls);
395 }
396 
397 
398 /* end of datacache.c */
const char * section
Configuration section to use.
struct GNUNET_CONTAINER_BloomFilter * GNUNET_CONTAINER_bloomfilter_init(const char *data, size_t size, unsigned int k)
Create a Bloom filter from raw bits.
void * cls
Closure to pass to all plugin functions.
struct GNUNET_DATACACHE_PluginEnvironment env
Environment provided to our plugin.
Definition: datacache.c:86
ssize_t(* put)(void *cls, const struct GNUNET_HashCode *key, uint32_t xor_distance, size_t size, const char *data, enum GNUNET_BLOCK_Type type, struct GNUNET_TIME_Absolute discard_time, unsigned int path_info_len, const struct GNUNET_PeerIdentity *path_info)
Store an item in the datastore.
void GNUNET_CONTAINER_bloomfilter_add(struct GNUNET_CONTAINER_BloomFilter *bf, const struct GNUNET_HashCode *e)
Add an element to the filter.
int(* del)(void *cls)
Delete the entry with the lowest expiration value from the datacache right now.
GNUNET_BLOCK_Type
Blocks in the datastore and the datacache must have a unique type.
const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration to use.
struct GNUNET_STATISTICS_Handle * GNUNET_STATISTICS_create(const char *subsystem, const struct GNUNET_CONFIGURATION_Handle *cfg)
Get handle for the statistics service.
static size_t data_size
Number of bytes in data.
Definition: gnunet-abd.c:187
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
void GNUNET_DATACACHE_destroy(struct GNUNET_DATACACHE_Handle *h)
Destroy a data cache (and free associated resources).
Definition: datacache.c:212
static int ret
Return value of the commandline.
Definition: gnunet-abd.c:81
int GNUNET_DATACACHE_put(struct GNUNET_DATACACHE_Handle *h, const struct GNUNET_HashCode *key, uint32_t xor_distance, size_t data_size, const char *data, enum GNUNET_BLOCK_Type type, struct GNUNET_TIME_Absolute discard_time, unsigned int path_info_len, const struct GNUNET_PeerIdentity *path_info)
Store an item in the datastore.
Definition: datacache.c:250
#define GNUNET_NO
Definition: gnunet_common.h:78
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
const char * GNUNET_h2s(const struct GNUNET_HashCode *hc)
Convert a hash value to a string (for printing debug messages).
#define GNUNET_new(type)
Allocate a struct or union of the given type.
void GNUNET_STATISTICS_destroy(struct GNUNET_STATISTICS_Handle *h, int sync_first)
Destroy a handle (free all state associated with it).
void GNUNET_STATISTICS_update(struct GNUNET_STATISTICS_Handle *handle, const char *name, int64_t delta, int make_persistent)
Set statistic value for the peer.
Handle for the service.
#define GNUNET_strdup(a)
Wrapper around GNUNET_xstrdup_.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
static struct GNUNET_ARM_Handle * h
Connection with ARM.
Definition: gnunet-arm.c:99
GNUNET_DATACACHE_DeleteNotifyCallback delete_notify
Function to call whenever the plugin needs to discard content that it was asked to store...
#define _(String)
GNU gettext support macro.
Definition: platform.h:181
void * GNUNET_PLUGIN_unload(const char *library_name, void *arg)
Unload plugin (runs the "done" callback and returns whatever "done" returned).
Definition: plugin.c:256
struct GNUNET_STATISTICS_Handle * stats
Opaque handle for the statistics service.
Definition: datacache.c:55
#define GNUNET_log_from_strerror_file(level, component, cmd, filename)
Log an error message at log-level &#39;level&#39; that indicates a failure of the command &#39;cmd&#39; with the mess...
char * short_name
Short name for the plugin (i.e.
Definition: datacache.c:71
unsigned long long utilization
How much space is in use right now?
Definition: datacache.c:91
int GNUNET_asprintf(char **buf, const char *format,...)
Like asprintf, just portable.
char * GNUNET_DISK_mktemp(const char *t)
Create an (empty) temporary file on disk.
Definition: disk.c:468
void GNUNET_log_config_missing(enum GNUNET_ErrorType kind, const char *section, const char *option)
Log error message about missing configuration option.
void GNUNET_CONTAINER_bloomfilter_remove(struct GNUNET_CONTAINER_BloomFilter *bf, const struct GNUNET_HashCode *e)
Remove an element from the filter.
int GNUNET_CONTAINER_bloomfilter_test(const struct GNUNET_CONTAINER_BloomFilter *bf, const struct GNUNET_HashCode *e)
Test if an element is in the filter.
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:313
unsigned int(* get_closest)(void *cls, const struct GNUNET_HashCode *key, 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.
struct GNUNET_DATACACHE_Handle * GNUNET_DATACACHE_create(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section)
Create a data cache.
Definition: datacache.c:133
struct GNUNET_CONTAINER_BloomFilter * filter
Bloomfilter to quickly tell if we don&#39;t have the content.
Definition: datacache.c:45
char * lib_name
Name of the library (i.e.
Definition: datacache.c:76
struct GNUNET_CONTAINER_BloomFilter * GNUNET_CONTAINER_bloomfilter_load(const char *filename, size_t size, unsigned int k)
Load a Bloom filter from a file.
struct returned by the initialization function of the plugin
A 512-bit hashcode.
int 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.
const struct GNUNET_CONFIGURATION_Handle * cfg
Our configuration.
Definition: datacache.c:50
int 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.
struct GNUNET_HashCode key
The key used in the DHT.
#define GNUNET_SYSERR
Definition: gnunet_common.h:76
static unsigned int size
Size of the "table".
Definition: peer.c:67
#define LOG(kind,...)
Definition: datacache.c:32
static unsigned long long quota
How much space are we allowed to use?
The identity of the host (wraps the signing key of the peer).
struct GNUNET_DATACACHE_PluginFunctions * api
API of the transport as returned by the plugin&#39;s initialization function.
Definition: datacache.c:66
Internal state of the datacache library.
Definition: datacache.c:40
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
configuration data
Definition: configuration.c:85
const char * name
int(* GNUNET_DATACACHE_Iterator)(void *cls, const struct GNUNET_HashCode *key, size_t data_size, const char *data, enum GNUNET_BLOCK_Type type, struct GNUNET_TIME_Absolute exp, unsigned int path_info_len, const struct GNUNET_PeerIdentity *path_info)
An iterator over a set of items stored in the datacache.
void * cls
Closure to use for callbacks.
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model
Time for absolute times used by GNUnet, in microseconds.
#define GNUNET_YES
Definition: gnunet_common.h:77
void * GNUNET_PLUGIN_load(const char *library_name, void *arg)
Setup plugin (runs the "init" callback and returns whatever "init" returned).
Definition: plugin.c:207
unsigned int(* get_random)(void *cls, GNUNET_DATACACHE_Iterator iter, void *iter_cls)
Return a random value from the datastore.
unsigned long long quota
How much space are we allowed to use?
int 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".
uint32_t data
The data value.
The datastore service will pass a pointer to a struct of this type as the first and only argument to ...
unsigned int GNUNET_DATACACHE_get_closest(struct GNUNET_DATACACHE_Handle *h, const struct GNUNET_HashCode *key, 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:380
char * section
Configuration section to use.
Definition: datacache.c:60
void GNUNET_CONTAINER_bloomfilter_free(struct GNUNET_CONTAINER_BloomFilter *bf)
Free the space associcated with a filter in memory, flush to drive if needed (do not free the space o...
char * bloom_name
Name for the bloom filter file.
Definition: datacache.c:81
unsigned int GNUNET_DATACACHE_get_random(struct GNUNET_DATACACHE_Handle *h, GNUNET_DATACACHE_Iterator iter, void *iter_cls)
Obtain a random element from the datacache.
Definition: datacache.c:352
unsigned int(* get)(void *cls, 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 datastore.
#define GNUNET_free(ptr)
Wrapper around free.
#define gettext_noop(String)
Definition: gettext.h:69