GNUnet  0.19.3
gnunet-service-dht_datacache.c
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2009, 2010, 2011, 2015, 2017, 2022 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  */
26 #include "platform.h"
27 #include "gnunet_datacache_lib.h"
31 #include "gnunet-service-dht.h"
32 
33 #define LOG(kind, ...) GNUNET_log_from (kind, "dht-dhtcache", __VA_ARGS__)
34 
39 #define NUM_CLOSEST 4
40 
41 
46 
47 
48 void
50 {
51  struct GNUNET_HashCode xor;
53 
54  if (NULL == datacache)
55  {
57  "PUT request received, but have no datacache!\n");
58  return;
59  }
61  {
62  GNUNET_break (0);
63  return;
64  }
65  /* Put size is actual data size plus struct overhead plus path length (if any) */
67  "# ITEMS stored in datacache",
68  1,
69  GNUNET_NO);
72  &xor);
75  bd);
77  "DATACACHE PUT for key %s [%lu] completed (%d) after %u hops\n",
78  GNUNET_h2s (&bd->key),
79  (unsigned long) bd->data_size,
80  r,
81  bd->put_path_length);
82 }
83 
84 
89 {
93  const void *xquery;
94 
98  struct GNUNET_HashCode key;
99 
104 
109 
113  void *gc_cls;
114 
118  size_t xquery_size;
119 
124 };
125 
126 
135 static enum GNUNET_GenericReturnValue
136 datacache_get_iterator (void *cls,
137  const struct GNUNET_DATACACHE_Block *bd)
138 {
139  struct GetRequestContext *ctx = cls;
141 
143  {
144  GNUNET_break (0); /* why does datacache return expired values? */
145  return GNUNET_OK; /* skip expired record */
146  }
147  eval
149  bd->type,
150  ctx->bg,
151  &bd->key,
152  ctx->xquery,
153  ctx->xquery_size,
154  bd->data,
155  bd->data_size);
157  "Evaluated reply for query %s in datacache, result is %d\n",
158  GNUNET_h2s (&bd->key),
159  (int) eval);
160  ctx->eval = eval;
161  switch (eval)
162  {
166  /* forward to initiator */
168  "# Good RESULTS found in datacache",
169  1,
170  GNUNET_NO);
171  ctx->gc (ctx->gc_cls,
172  bd);
173  break;
176  "# Duplicate RESULTS found in datacache",
177  1,
178  GNUNET_NO);
179  break;
182  "# Irrelevant RESULTS found in datacache",
183  1,
184  GNUNET_NO);
185  break;
186  }
188 }
189 
190 
193  enum GNUNET_BLOCK_Type type,
194  const void *xquery,
195  size_t xquery_size,
196  struct GNUNET_BLOCK_Group *bg,
198  void *gc_cls)
199 {
200  struct GetRequestContext ctx = {
202  .key = *key,
203  .xquery = xquery,
204  .xquery_size = xquery_size,
205  .bg = bg,
206  .gc = gc,
207  .gc_cls = gc_cls
208  };
209  unsigned int r;
210 
211  if (NULL == datacache)
214  "# GET requests given to datacache",
215  1,
216  GNUNET_NO);
218  key,
219  type,
221  &ctx);
223  "DATACACHE GET for key %s completed (%d). %u results found.\n",
224  GNUNET_h2s (key),
225  ctx.eval,
226  r);
227  return ctx.eval;
228 }
229 
230 
233  enum GNUNET_BLOCK_Type type,
234  const void *xquery,
235  size_t xquery_size,
236  struct GNUNET_BLOCK_Group *bg,
238  void *cb_cls)
239 {
240  struct GetRequestContext ctx = {
242  .key = *key,
243  .xquery = xquery,
244  .xquery_size = xquery_size,
245  .bg = bg,
246  .gc = cb,
247  .gc_cls = cb_cls
248  };
249  unsigned int r;
250 
251  if (NULL == datacache)
254  "# GET closest requests given to datacache",
255  1,
256  GNUNET_NO);
258  key,
259  type,
260  NUM_CLOSEST,
262  &ctx);
264  "DATACACHE approximate GET for key %s completed (%d). %u results found.\n",
265  GNUNET_h2s (key),
266  ctx.eval,
267  r);
268  return ctx.eval;
269 }
270 
271 
272 void
274 {
276  "dhtcache");
277 }
278 
279 
280 void
282 {
283  if (NULL != datacache)
284  {
286  datacache = NULL;
287  }
288 }
289 
290 
291 /* end of gnunet-service-dht_datacache.c */
GNUNET_BLOCK_Type
WARNING: This header is generated! In order to add DHT block types, you must register them in GANA,...
struct GNUNET_HashCode key
The key used in the DHT.
struct GNUNET_HashCode GDS_my_identity_hash
Hash of the identity of this peer.
GNUnet DHT globals.
struct GNUNET_STATISTICS_Handle * GDS_stats
Handle for the statistics service.
struct GNUNET_BLOCK_Context * GDS_block_context
Our handle to the BLOCK library.
const struct GNUNET_CONFIGURATION_Handle * GDS_cfg
Configuration we use.
#define NUM_CLOSEST
How many "closest" results to we return for migration when asked (at most)?
void GDS_DATACACHE_init()
Initialize datacache subsystem.
enum GNUNET_BLOCK_ReplyEvaluationResult GDS_DATACACHE_get_closest(const struct GNUNET_HashCode *key, enum GNUNET_BLOCK_Type type, const void *xquery, size_t xquery_size, struct GNUNET_BLOCK_Group *bg, GDS_DATACACHE_GetCallback cb, void *cb_cls)
Handle a request for data close to a key that we have received from another peer.
enum GNUNET_BLOCK_ReplyEvaluationResult GDS_DATACACHE_handle_get(const struct GNUNET_HashCode *key, enum GNUNET_BLOCK_Type type, const void *xquery, size_t xquery_size, struct GNUNET_BLOCK_Group *bg, GDS_DATACACHE_GetCallback gc, void *gc_cls)
Handle a GET request we've received from another peer.
void GDS_DATACACHE_handle_put(const struct GNUNET_DATACACHE_Block *bd)
Handle a datum we've received from another peer.
void GDS_DATACACHE_done()
Shutdown datacache subsystem.
#define LOG(kind,...)
static struct GNUNET_DATACACHE_Handle * datacache
Handle to the datacache service (for inserting/retrieving data)
static enum GNUNET_GenericReturnValue datacache_get_iterator(void *cls, const struct GNUNET_DATACACHE_Block *bd)
Iterator for local get request results,.
GNUnet DHT service's datacache integration.
void(* GDS_DATACACHE_GetCallback)(void *cls, const struct GNUNET_DATACACHE_Block *bd)
Handle a result for a GET operation.
GNUnet DHT routing code.
GNUnet DHT tracking of requests for routing replies.
static struct GNUNET_DNSSTUB_Context * ctx
Context for DNS resolution.
#define GNUNET_MAX_MESSAGE_SIZE
Largest supported message (to be precise, one byte more than the largest possible message,...
enum GNUNET_BLOCK_ReplyEvaluationResult GNUNET_BLOCK_check_reply(struct GNUNET_BLOCK_Context *ctx, enum GNUNET_BLOCK_Type type, struct GNUNET_BLOCK_Group *group, const struct GNUNET_HashCode *query, const void *xquery, size_t xquery_size, const void *reply_block, size_t reply_block_size)
Function called to validate if a reply is good for a particular query.
Definition: block.c:337
GNUNET_BLOCK_ReplyEvaluationResult
Possible ways for how a block may relate to a query.
@ GNUNET_BLOCK_REPLY_OK_MORE
Valid result, and there may be more.
@ GNUNET_BLOCK_REPLY_OK_DUPLICATE
Valid result, but suppressed because it is a duplicate.
@ GNUNET_BLOCK_REPLY_OK_LAST
Last possible valid result.
@ GNUNET_BLOCK_REPLY_TYPE_NOT_SUPPORTED
Specified block type not supported by any plugin.
@ GNUNET_BLOCK_REPLY_IRRELEVANT
Block does not match xquery (valid result, not relevant for the request)
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:303
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:261
struct GNUNET_DATACACHE_Handle * GNUNET_DATACACHE_create(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section)
Create a data cache.
Definition: datacache.c:128
void GNUNET_DATACACHE_destroy(struct GNUNET_DATACACHE_Handle *h)
Destroy a data cache (and free associated resources).
Definition: datacache.c:235
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:338
void GNUNET_CRYPTO_hash_xor(const struct GNUNET_HashCode *a, const struct GNUNET_HashCode *b, struct GNUNET_HashCode *result)
compute result = a ^ b
Definition: crypto_hash.c:135
unsigned int GNUNET_CRYPTO_hash_count_leading_zeros(const struct GNUNET_HashCode *h)
Count the number of leading 0 bits in h.
Definition: crypto_hash.c:176
#define GNUNET_log(kind,...)
GNUNET_GenericReturnValue
Named constants for return values.
@ GNUNET_OK
@ GNUNET_NO
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur.
const char * GNUNET_h2s(const struct GNUNET_HashCode *hc)
Convert a hash value to a string (for printing debug messages).
@ GNUNET_ERROR_TYPE_WARNING
@ GNUNET_ERROR_TYPE_DEBUG
void GNUNET_STATISTICS_update(struct GNUNET_STATISTICS_Handle *handle, const char *name, int64_t delta, int make_persistent)
Set statistic value for the peer.
bool GNUNET_TIME_absolute_is_past(struct GNUNET_TIME_Absolute abs)
Test if abs is truly in the past (excluding now).
Definition: time.c:669
Block group data.
Information about a block stored in the datacache.
enum GNUNET_BLOCK_Type type
Type of the block.
const void * data
Actual block data.
struct GNUNET_HashCode key
Key of the block.
size_t data_size
Number of bytes in data.
unsigned int put_path_length
Length of the put_path array.
struct GNUNET_TIME_Absolute expiration_time
When does the block expire?
Internal state of the datacache library.
Definition: datacache.c:41
A 512-bit hashcode.
Context containing information about a GET request.
enum GNUNET_BLOCK_ReplyEvaluationResult eval
Return value to give back.
struct GNUNET_BLOCK_Group * bg
Block group to use to evaluate replies (updated)
GDS_DATACACHE_GetCallback gc
Function to call on results.
struct GNUNET_HashCode key
The key this request was about.
const void * xquery
extended query (see gnunet_block_lib.h).
void * gc_cls
Closure for gc.
size_t xquery_size
Number of bytes in xquery.
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model