GNUnet  0.11.x
plugin_datacache_heap.c
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet
3  Copyright (C) 2012, 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  */
20 
26 #include "platform.h"
27 #include "gnunet_util_lib.h"
29 
30 #define LOG(kind, ...) GNUNET_log_from (kind, "datacache-heap", __VA_ARGS__)
31 
32 #define LOG_STRERROR_FILE(kind, op, fn) GNUNET_log_from_strerror_file (kind, \
33  "datacache-heap", \
34  op, fn)
35 
36 #define NUM_HEAPS 24
37 
41 struct Plugin
42 {
47 
52 
57 };
58 
59 
63 struct Value
64 {
69 
73  struct GNUNET_TIME_Absolute discard_time;
74 
79 
84 
88  size_t size;
89 
93  unsigned int path_info_len;
94 
98  uint32_t distance;
99 
104 };
105 
106 
107 #define OVERHEAD (sizeof(struct Value) + 64)
108 
109 
114 {
118  struct GNUNET_TIME_Absolute discard_time;
119 
123  const char *data;
124 
129 
133  size_t size;
134 
139 
143  unsigned int path_info_len;
144 
148  int found;
149 };
150 
151 
161 static int
162 put_cb (void *cls,
163  const struct GNUNET_HashCode *key,
164  void *value)
165 {
166  struct PutContext *put_ctx = cls;
167  struct Value *val = value;
168 
169  if ((val->size == put_ctx->size) &&
170  (val->type == put_ctx->type) &&
171  (0 == memcmp (&val[1],
172  put_ctx->data,
173  put_ctx->size)))
174  {
175  put_ctx->found = GNUNET_YES;
177  put_ctx->discard_time);
178  /* replace old path with new path */
180  val->path_info_len,
181  put_ctx->path_info_len);
182  GNUNET_memcpy (val->path_info,
183  put_ctx->path_info,
184  put_ctx->path_info_len * sizeof(struct GNUNET_PeerIdentity));
188  "Got same value for key %s and type %d (size %u vs %u)\n",
189  GNUNET_h2s (key),
190  val->type,
191  (unsigned int) val->size,
192  (unsigned int) put_ctx->size);
193  return GNUNET_NO;
194  }
195  return GNUNET_YES;
196 }
197 
198 
213 static ssize_t
214 heap_plugin_put (void *cls,
215  const struct GNUNET_HashCode *key,
216  uint32_t xor_distance,
217  size_t size,
218  const char *data,
219  enum GNUNET_BLOCK_Type type,
221  unsigned int path_info_len,
222  const struct GNUNET_PeerIdentity *path_info)
223 {
224  struct Plugin *plugin = cls;
225  struct Value *val;
226  struct PutContext put_ctx;
227 
228  put_ctx.found = GNUNET_NO;
229  put_ctx.data = data;
230  put_ctx.size = size;
231  put_ctx.path_info = path_info;
232  put_ctx.path_info_len = path_info_len;
233  put_ctx.discard_time = discard_time;
234  put_ctx.type = type;
236  key,
237  &put_cb,
238  &put_ctx);
239  if (GNUNET_YES == put_ctx.found)
240  return 0;
241  val = GNUNET_malloc (sizeof(struct Value) + size);
242  GNUNET_memcpy (&val[1],
243  data,
244  size);
245  val->key = *key;
246  val->type = type;
247  val->discard_time = discard_time;
248  val->size = size;
249  if (xor_distance >= NUM_HEAPS)
250  val->distance = NUM_HEAPS - 1;
251  else
252  val->distance = xor_distance;
254  val->path_info_len,
255  path_info_len);
256  GNUNET_memcpy (val->path_info,
257  path_info,
258  path_info_len * sizeof(struct GNUNET_PeerIdentity));
259  (void) GNUNET_CONTAINER_multihashmap_put (plugin->map,
260  &val->key,
261  val,
263  val->hn = GNUNET_CONTAINER_heap_insert (plugin->heaps[val->distance],
264  val,
266  return size + OVERHEAD;
267 }
268 
269 
274 {
279 
283  void *iter_cls;
284 
288  unsigned int cnt;
289 
294 };
295 
296 
306 static int
307 get_cb (void *cls,
308  const struct GNUNET_HashCode *key,
309  void *value)
310 {
311  struct GetContext *get_ctx = cls;
312  struct Value *val = value;
313  int ret;
314 
315  if ((get_ctx->type != val->type) &&
316  (GNUNET_BLOCK_TYPE_ANY != get_ctx->type))
317  return GNUNET_OK;
318  if (0 ==
320  return GNUNET_OK;
321  if (NULL != get_ctx->iter)
322  ret = get_ctx->iter (get_ctx->iter_cls,
323  key,
324  val->size,
325  (const char *) &val[1],
326  val->type,
327  val->discard_time,
328  val->path_info_len,
329  val->path_info);
330  else
331  ret = GNUNET_YES;
332  get_ctx->cnt++;
333  return ret;
334 }
335 
336 
348 static unsigned int
349 heap_plugin_get (void *cls,
350  const struct GNUNET_HashCode *key,
351  enum GNUNET_BLOCK_Type type,
353  void *iter_cls)
354 {
355  struct Plugin *plugin = cls;
356  struct GetContext get_ctx;
357 
358  get_ctx.type = type;
359  get_ctx.iter = iter;
360  get_ctx.iter_cls = iter_cls;
361  get_ctx.cnt = 0;
363  key,
364  &get_cb,
365  &get_ctx);
366  return get_ctx.cnt;
367 }
368 
369 
377 static int
378 heap_plugin_del (void *cls)
379 {
380  struct Plugin *plugin = cls;
381  struct Value *val;
382 
383  for (unsigned int i = 0; i < NUM_HEAPS; i++)
384  {
385  val = GNUNET_CONTAINER_heap_remove_root (plugin->heaps[i]);
386  if (NULL != val)
387  break;
388  }
389  if (NULL == val)
390  return GNUNET_SYSERR;
393  &val->key,
394  val));
395  plugin->env->delete_notify (plugin->env->cls,
396  &val->key,
397  val->size + OVERHEAD);
399  GNUNET_free (val);
400  return GNUNET_OK;
401 }
402 
403 
412 static unsigned int
415  void *iter_cls)
416 {
417  struct Plugin *plugin = cls;
418  struct GetContext get_ctx;
419 
420  get_ctx.type = GNUNET_BLOCK_TYPE_ANY;
421  get_ctx.iter = iter;
422  get_ctx.iter_cls = iter_cls;
423  get_ctx.cnt = 0;
425  &get_cb,
426  &get_ctx);
427  return get_ctx.cnt;
428 }
429 
430 
435 {
436  struct Value **values;
437 
438  unsigned int num_results;
439 
440  const struct GNUNET_HashCode *key;
441 };
442 
443 
444 static int
445 find_closest (void *cls,
446  const struct GNUNET_HashCode *key,
447  void *value)
448 {
449  struct GetClosestContext *gcc = cls;
450  struct Value *val = value;
451  unsigned int j;
452 
453  if (1 != GNUNET_CRYPTO_hash_cmp (key,
454  gcc->key))
455  return GNUNET_OK; /* useless */
456  j = gcc->num_results;
457  for (unsigned int i = 0; i < gcc->num_results; i++)
458  {
459  if (NULL == gcc->values[i])
460  {
461  j = i;
462  break;
463  }
464  if (1 == GNUNET_CRYPTO_hash_cmp (&gcc->values[i]->key,
465  key))
466  {
467  j = i;
468  break;
469  }
470  }
471  if (j == gcc->num_results)
472  return GNUNET_OK;
473  gcc->values[j] = val;
474  return GNUNET_OK;
475 }
476 
477 
491 static unsigned int
493  const struct GNUNET_HashCode *key,
494  unsigned int num_results,
496  void *iter_cls)
497 {
498  struct Plugin *plugin = cls;
499  struct Value *values[num_results];
500  struct GetClosestContext gcc = {
501  .values = values,
502  .num_results = num_results,
503  .key = key
504  };
505 
507  &find_closest,
508  &gcc);
509  for (unsigned int i = 0; i < num_results; i++)
510  {
511  if (NULL == values[i])
512  return i;
513  iter (iter_cls,
514  &values[i]->key,
515  values[i]->size,
516  (void *) &values[i][1],
517  values[i]->type,
518  values[i]->discard_time,
519  values[i]->path_info_len,
520  values[i]->path_info);
521  }
522  return num_results;
523 }
524 
525 
532 void *
534 {
537  struct Plugin *plugin;
538 
539  plugin = GNUNET_new (struct Plugin);
540  plugin->map = GNUNET_CONTAINER_multihashmap_create (1024, /* FIXME: base on quota! */
541  GNUNET_YES);
542  for (unsigned int i = 0; i < NUM_HEAPS; i++)
543  plugin->heaps[i] = GNUNET_CONTAINER_heap_create (
545  plugin->env = env;
547  api->cls = plugin;
548  api->get = &heap_plugin_get;
549  api->put = &heap_plugin_put;
550  api->del = &heap_plugin_del;
554  _ ("Heap datacache running\n"));
555  return api;
556 }
557 
558 
565 void *
567 {
569  struct Plugin *plugin = api->cls;
570  struct Value *val;
571 
572  for (unsigned int i = 0; i < NUM_HEAPS; i++)
573  {
574  while (NULL != (val = GNUNET_CONTAINER_heap_remove_root (plugin->heaps[i])))
575  {
578  &val->key,
579  val));
581  GNUNET_free (val);
582  }
584  }
586  GNUNET_free (plugin);
587  GNUNET_free (api);
588  return NULL;
589 }
590 
591 
592 /* end of plugin_datacache_heap.c */
void * cls
Closure to pass to all plugin functions.
size_t size
Payload (actual payload follows this struct)
void GNUNET_CONTAINER_heap_update_cost(struct GNUNET_CONTAINER_HeapNode *node, GNUNET_CONTAINER_HeapCostType new_cost)
Updates the cost of any node in the tree.
unsigned int path_info_len
Number of entries in path_info.
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.
int(* del)(void *cls)
Delete the entry with the lowest expiration value from the datacache right now.
uint64_t rel_value_us
The actual value.
void * libgnunet_plugin_datacache_heap_init(void *cls)
Entry point for the plugin.
Any type of block, used as a wildcard when searching.
static struct GNUNET_CONTAINER_MultiHashMap * values
Collection of all values (represented with ValueSet).
struct GNUNET_CONTAINER_HeapNode * GNUNET_CONTAINER_heap_insert(struct GNUNET_CONTAINER_Heap *heap, void *element, GNUNET_CONTAINER_HeapCostType cost)
Inserts a new element into the heap.
size_t size
Number of bytes in data.
GNUNET_BLOCK_Type
Blocks in the datastore and the datacache must have a unique type.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
static int heap_plugin_del(void *cls)
Delete the entry with the lowest expiration value from the datacache right now.
uint32_t distance
How close is the hash to us? Determines which heap we are in!
struct GNUNET_CONTAINER_Heap * heaps[24]
Heaps sorted by distance.
char * key
TLS key.
const char * data
Data for the new value.
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
static int ret
Return value of the commandline.
Definition: gnunet-abd.c:81
static int get_cb(void *cls, const struct GNUNET_HashCode *key, void *value)
Function called during GET to find matching blocks.
#define GNUNET_NO
Definition: gnunet_common.h:78
struct GNUNET_CONTAINER_MultiHashMap * map
Our hash map.
#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_free_non_null(ptr)
Free the memory pointed to by ptr if ptr is not NULL.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
void * iter_cls
Closure for iter.
static unsigned int heap_plugin_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.
static ssize_t heap_plugin_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.
static int find_closest(void *cls, const struct GNUNET_HashCode *key, void *value)
const struct GNUNET_HashCode * key
uint64_t abs_value_us
The actual value.
Internal representation of the hash map.
#define OVERHEAD
struct GNUNET_BLOCK_PluginFunctions * api
Plugin API.
Definition: block.c:47
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
struct GNUNET_TIME_Absolute discard_time
Expiration time for the new value.
unsigned int cnt
Number of results found.
Closure for put_cb().
#define GNUNET_array_grow(arr, size, tsize)
Grow a well-typed (!) array.
int found
Value to set to GNUNET_YES if an equivalent block was found.
static char * value
Value of the record to add/remove.
struct GNUNET_DATACACHE_PluginEnvironment * env
Our execution environment.
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.
void GNUNET_CONTAINER_multihashmap_destroy(struct GNUNET_CONTAINER_MultiHashMap *map)
Destroy a hash map.
unsigned int GNUNET_CONTAINER_multihashmap_get_random(const struct GNUNET_CONTAINER_MultiHashMap *map, GNUNET_CONTAINER_MulitHashMapIteratorCallback it, void *it_cls)
Call it on a random value from the map, or not at all if the map is empty.
GNUNET_DATACACHE_Iterator iter
Function to call for each result.
enum GNUNET_BLOCK_Type type
Type of the block.
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_max(struct GNUNET_TIME_Absolute t1, struct GNUNET_TIME_Absolute t2)
Return the maximum of two absolute time values.
Definition: time.c:317
int GNUNET_CONTAINER_multihashmap_remove(struct GNUNET_CONTAINER_MultiHashMap *map, const struct GNUNET_HashCode *key, const void *value)
Remove the given key-value pair from the map.
struct returned by the initialization function of the plugin
Handle to a node in a heap.
enum GNUNET_BLOCK_Type type
Block type requested.
Heap with the minimum cost at the root.
#define NUM_HEAPS
void GNUNET_CONTAINER_heap_destroy(struct GNUNET_CONTAINER_Heap *heap)
Destroys the heap.
A 512-bit hashcode.
static char * plugin
Solver plugin name as string.
static unsigned int heap_plugin_get_random(void *cls, GNUNET_DATACACHE_Iterator iter, void *iter_cls)
Return a random value from the datastore.
struct GNUNET_HashCode key
Key for the entry.
Node in the heap.
Closure for find_closest().
#define GNUNET_SYSERR
Definition: gnunet_common.h:76
void * iter_cls
Iterator cls.
const struct GNUNET_PeerIdentity * path_info
Path information.
Closure for get_cb().
#define LOG(kind,...)
unsigned int path_info_len
Number of entries in path_info.
int GNUNET_CONTAINER_multihashmap_put(struct GNUNET_CONTAINER_MultiHashMap *map, const struct GNUNET_HashCode *key, void *value, enum GNUNET_CONTAINER_MultiHashMapOption opt)
Store a key-value pair in the map.
struct GNUNET_CONTAINER_Heap * GNUNET_CONTAINER_heap_create(enum GNUNET_CONTAINER_HeapOrder order)
Create a new heap.
Allow multiple values with the same key.
Entry in the hash map.
static unsigned int heap_plugin_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.
The identity of the host (wraps the signing key of the peer).
int GNUNET_CONTAINER_multihashmap_get_multiple(struct GNUNET_CONTAINER_MultiHashMap *map, const struct GNUNET_HashCode *key, GNUNET_CONTAINER_MulitHashMapIteratorCallback it, void *it_cls)
Iterate over all entries in the map that match a particular key.
unsigned long long size
Size of all values we&#39;re storing.
Handle for a plugin.
Definition: block.c:37
int GNUNET_CRYPTO_hash_cmp(const struct GNUNET_HashCode *h1, const struct GNUNET_HashCode *h2)
Compare function for HashCodes, producing a total ordering of all hashcodes.
Definition: crypto_hash.c:294
void * libgnunet_plugin_datacache_heap_done(void *cls)
Exit point from the plugin.
struct GNUNET_CONTAINER_HeapNode * hn
Corresponding node in the heap.
#define GNUNET_log(kind,...)
void * GNUNET_CONTAINER_heap_remove_root(struct GNUNET_CONTAINER_Heap *heap)
Remove root of the heap.
struct GNUNET_CONTAINER_MultiHashMap * GNUNET_CONTAINER_multihashmap_create(unsigned int len, int do_not_copy_keys)
Create a multi hash map.
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.
struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_remaining(struct GNUNET_TIME_Absolute future)
Given a timestamp in the future, how much time remains until then?
Definition: time.c:331
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
unsigned int(* get_random)(void *cls, GNUNET_DATACACHE_Iterator iter, void *iter_cls)
Return a random value from the datastore.
struct GNUNET_TIME_Absolute discard_time
Expiration time.
static int put_cb(void *cls, const struct GNUNET_HashCode *key, void *value)
Function called during PUT to detect if an equivalent block already exists.
int GNUNET_CONTAINER_multihashmap_iterate(struct GNUNET_CONTAINER_MultiHashMap *map, GNUNET_CONTAINER_MulitHashMapIteratorCallback it, void *it_cls)
Iterate over all entries in the map.
uint32_t data
The data value.
struct GNUNET_PeerIdentity * path_info
Path information.
The datastore service will pass a pointer to a struct of this type as the first and only argument to ...
GNUNET_PEERSTORE_Processor iter
Iterator.
enum GNUNET_BLOCK_Type type
Type of the node.
#define GNUNET_malloc(size)
Wrapper around malloc.
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.