GNUnet 0.22.2
gnunet-service-namecache.c
Go to the documentation of this file.
1/*
2 This file is part of GNUnet.
3 Copyright (C) 2012, 2013 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
27#include "gnunet_util_lib.h"
30#include "namecache.h"
31
32#define LOG_STRERROR_FILE(kind, syscall, \
33 filename) GNUNET_log_from_strerror_file (kind, "util", \
34 syscall, \
35 filename)
36
37
42{
47
52};
53
54
59
64
69
73static char *db_lib_name;
74
75
81static void
83{
85 "Stopping namecache service\n");
86 GNUNET_break (NULL ==
90 db_lib_name = NULL;
91 if (NULL != statistics)
92 {
94 GNUNET_NO);
95 statistics = NULL;
96 }
97}
98
99
108static void
110 struct GNUNET_SERVICE_Client *client,
111 void *app_ctx)
112{
113 struct NamecacheClient *nc = app_ctx;
114
116 "Client %p disconnected\n",
117 client);
118 GNUNET_free (nc);
119}
120
121
130static void *
133 struct GNUNET_MQ_Handle *mq)
134{
135 struct NamecacheClient *nc;
136
138 "Client %p connected\n",
139 client);
140 nc = GNUNET_new (struct NamecacheClient);
141 nc->client = client;
142 nc->mq = mq;
143 return nc;
144}
145
146
152{
157
161 uint32_t request_id;
162
167};
168
169
176static void
178 const struct GNUNET_GNSRECORD_Block *block)
179{
180 struct LookupBlockContext *lnc = cls;
181 struct GNUNET_MQ_Envelope *env;
183 size_t bsize;
184
187 bsize,
189 r->gns_header.r_id = htonl (lnc->request_id);
190 GNUNET_memcpy (&r[1],
191 block,
192 bsize);
194 "blocks found in cache",
195 1,
196 GNUNET_NO);
200 "Sending NAMECACHE_LOOKUP_BLOCK_RESPONSE message\n");
201 GNUNET_MQ_send (lnc->nc->mq,
202 env);
203}
204
205
212static void
214 const struct LookupBlockMessage *ln_msg)
215{
216 struct NamecacheClient *nc = cls;
217 struct GNUNET_MQ_Envelope *env;
218 struct LookupBlockContext lnc;
219 struct LookupBlockResponseMessage *zir_end;
220 int ret;
221
223 "Received NAMECACHE_LOOKUP_BLOCK message\n");
225 "blocks looked up",
226 1,
227 GNUNET_NO);
228 lnc.request_id = ntohl (ln_msg->gns_header.r_id);
229 lnc.nc = nc;
230 lnc.status = GNUNET_OK;
231 if (GNUNET_SYSERR ==
233 &ln_msg->query,
235 &lnc)))
236 {
237 /* internal error (in database plugin); might be best to just hang up on
238 plugin rather than to signal that there are 'no' results, which
239 might also be false... */
240 GNUNET_break (0);
242 return;
243 }
244 if ((0 == ret) || (GNUNET_SYSERR == lnc.status))
245 {
246 /* no records match at all, generate empty response */
248 "Sending empty NAMECACHE_LOOKUP_BLOCK_RESPONSE message\n");
249 env = GNUNET_MQ_msg (zir_end,
251 zir_end->gns_header.r_id = ln_msg->gns_header.r_id;
252 GNUNET_MQ_send (nc->mq,
253 env);
254 }
256}
257
258
266static int
268 const struct BlockCacheMessage *rp_msg)
269{
270 return GNUNET_OK;
271}
272
273
280static void
282 const struct BlockCacheMessage *rp_msg)
283{
284 struct NamecacheClient *nc = cls;
285 struct GNUNET_MQ_Envelope *env;
286 struct BlockCacheResponseMessage *rpr_msg;
287 struct GNUNET_GNSRECORD_Block *block;
288 size_t esize;
289 int res;
290
292 "blocks cached",
293 1,
294 GNUNET_NO);
295 esize = ntohs (rp_msg->gns_header.header.size) - sizeof(struct
297 block = GNUNET_malloc (esize);
298 memcpy (block, &rp_msg[1], esize);
300 "Received NAMECACHE_BLOCK_CACHE message with type %u\n",
301 htonl (block->type));
303 block);
304 GNUNET_free (block);
305 env = GNUNET_MQ_msg (rpr_msg,
307 rpr_msg->gns_header.r_id = rp_msg->gns_header.r_id;
308 rpr_msg->op_result = htonl (res);
309 GNUNET_MQ_send (nc->mq,
310 env);
312}
313
314
322static void
323run (void *cls,
324 const struct GNUNET_CONFIGURATION_Handle *cfg,
326{
327 char *database;
328
330 "Starting namecache service\n");
331 GSN_cfg = cfg;
332
333 /* Loading database plugin */
334 if (GNUNET_OK !=
336 "namecache",
337 "database",
338 &database))
340 "No database backend configured\n");
341
343 "libgnunet_plugin_namecache_%s",
344 database);
347 (void *) GSN_cfg);
348 GNUNET_free (database);
349 if (NULL == GSN_database)
350 {
352 "Could not load database backend `%s'\n",
355 NULL);
356 return;
357 }
359 cfg);
360
361 /* Configuring server handles */
363 NULL);
364}
365
366
372 "namecache",
374 &run,
377 NULL,
378 GNUNET_MQ_hd_fixed_size (lookup_block,
380 struct LookupBlockMessage,
381 NULL),
382 GNUNET_MQ_hd_var_size (block_cache,
384 struct BlockCacheMessage,
385 NULL),
387
388
389/* end of gnunet-service-namecache.c */
struct GNUNET_MQ_Handle * mq
Definition: 003.c:5
struct GNUNET_MQ_Envelope * env
Definition: 005.c:1
static int ret
Final status code.
Definition: gnunet-arm.c:93
static struct GNUNET_CONFIGURATION_Handle * cfg
Our configuration.
Definition: gnunet-arm.c:108
static char * res
Currently read line or NULL on EOF.
static struct GNUNET_SERVICE_Handle * service
Handle to our service instance.
static struct GNUNET_NotificationContext * nc
Notification context for broadcasting to monitors.
static void handle_lookup_block(void *cls, const struct LookupBlockMessage *ln_msg)
Handles a GNUNET_MESSAGE_TYPE_NAMECACHE_LOOKUP_BLOCK message.
GNUNET_SERVICE_MAIN(GNUNET_OS_project_data_gnunet(), "namecache", GNUNET_SERVICE_OPTION_NONE, &run, &client_connect_cb, &client_disconnect_cb, NULL, GNUNET_MQ_hd_fixed_size(lookup_block, GNUNET_MESSAGE_TYPE_NAMECACHE_LOOKUP_BLOCK, struct LookupBlockMessage, NULL), GNUNET_MQ_hd_var_size(block_cache, GNUNET_MESSAGE_TYPE_NAMECACHE_BLOCK_CACHE, struct BlockCacheMessage, NULL), GNUNET_MQ_handler_end())
Define "main" method using service macro.
static void handle_block_cache(void *cls, const struct BlockCacheMessage *rp_msg)
Handles a GNUNET_MESSAGE_TYPE_NAMECACHE_BLOCK_CACHE message.
static void cleanup_task(void *cls)
Task run during shutdown.
static struct GNUNET_NAMECACHE_PluginFunctions * GSN_database
Database handle.
static char * db_lib_name
Name of the database plugin.
static void handle_lookup_block_it(void *cls, const struct GNUNET_GNSRECORD_Block *block)
A GNUNET_NAMECACHE_BlockCallback for name lookups in handle_lookup_block.
static struct GNUNET_STATISTICS_Handle * statistics
Handle to the statistics service.
static void * client_connect_cb(void *cls, struct GNUNET_SERVICE_Client *client, struct GNUNET_MQ_Handle *mq)
Add a client to our list of active clients.
static const struct GNUNET_CONFIGURATION_Handle * GSN_cfg
Configuration handle.
static int check_block_cache(void *cls, const struct BlockCacheMessage *rp_msg)
Check a GNUNET_MESSAGE_TYPE_NAMECACHE_BLOCK_CACHE message.
static void client_disconnect_cb(void *cls, struct GNUNET_SERVICE_Client *client, void *app_ctx)
Called whenever a client is disconnected.
static void run(void *cls, const struct GNUNET_CONFIGURATION_Handle *cfg, struct GNUNET_SERVICE_Handle *service)
Process namecache requests.
static unsigned int bsize
Plugin API for the namecache database backend.
API to create, modify and access statistics.
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.
size_t GNUNET_GNSRECORD_block_get_size(const struct GNUNET_GNSRECORD_Block *block)
Returns the length of this block in bytes.
struct GNUNET_TIME_Absolute GNUNET_GNSRECORD_block_get_expiration(const struct GNUNET_GNSRECORD_Block *block)
Returns the expiration of a block.
#define GNUNET_log(kind,...)
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
uint16_t size
The length of the struct (in bytes, including the length field itself), in big-endian format.
@ GNUNET_OK
@ GNUNET_NO
@ GNUNET_SYSERR
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur.
@ GNUNET_ERROR_TYPE_ERROR
@ GNUNET_ERROR_TYPE_DEBUG
int int GNUNET_asprintf(char **buf, const char *format,...) __attribute__((format(printf
Like asprintf, just portable.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
#define GNUNET_malloc(size)
Wrapper around malloc.
#define GNUNET_free(ptr)
Wrapper around free.
void GNUNET_MQ_send(struct GNUNET_MQ_Handle *mq, struct GNUNET_MQ_Envelope *ev)
Send a message with the given message queue.
Definition: mq.c:305
#define GNUNET_MQ_handler_end()
End-marker for the handlers array.
#define GNUNET_MQ_msg_extra(mvar, esize, type)
Allocate an envelope, with extra space allocated after the space needed by the message struct.
Definition: gnunet_mq_lib.h:61
#define GNUNET_MQ_msg(mvar, type)
Allocate a GNUNET_MQ_Envelope.
Definition: gnunet_mq_lib.h:76
#define GNUNET_MQ_hd_var_size(name, code, str, ctx)
#define GNUNET_MQ_hd_fixed_size(name, code, str, ctx)
const struct GNUNET_OS_ProjectData * GNUNET_OS_project_data_gnunet(void)
Return default project data used by 'libgnunetutil' for GNUnet.
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
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
#define GNUNET_MESSAGE_TYPE_NAMECACHE_LOOKUP_BLOCK
Client to service: lookup block.
#define GNUNET_MESSAGE_TYPE_NAMECACHE_BLOCK_CACHE_RESPONSE
Service to client: result of block cache request.
#define GNUNET_MESSAGE_TYPE_NAMECACHE_BLOCK_CACHE
Client to service: cache a block.
#define GNUNET_MESSAGE_TYPE_NAMECACHE_LOOKUP_BLOCK_RESPONSE
Service to client: result of block lookup.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_shutdown(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run on shutdown, that is when a CTRL-C signal is received,...
Definition: scheduler.c:1339
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_now(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run as soon as possible.
Definition: scheduler.c:1304
void GNUNET_SERVICE_client_drop(struct GNUNET_SERVICE_Client *c)
Ask the server to disconnect from the given client.
Definition: service.c:2418
void GNUNET_SERVICE_client_continue(struct GNUNET_SERVICE_Client *c)
Continue receiving further messages from the given client.
Definition: service.c:2389
@ GNUNET_SERVICE_OPTION_NONE
Use defaults.
struct GNUNET_STATISTICS_Handle * GNUNET_STATISTICS_create(const char *subsystem, const struct GNUNET_CONFIGURATION_Handle *cfg)
Get handle for the statistics service.
void GNUNET_STATISTICS_update(struct GNUNET_STATISTICS_Handle *handle, const char *name, int64_t delta, int make_persistent)
Set statistic value for the peer.
void GNUNET_STATISTICS_destroy(struct GNUNET_STATISTICS_Handle *h, int sync_first)
Destroy a handle (free all state associated with it).
struct GNUNET_TIME_AbsoluteNBO GNUNET_TIME_absolute_hton(struct GNUNET_TIME_Absolute a)
Convert absolute time to network byte order.
Definition: time.c:640
common internal definitions for namecache service
Cache a record in the namecache.
Definition: namecache.h:95
struct GNUNET_NAMECACHE_Header gns_header
Type will be GNUNET_MESSAGE_TYPE_NAMECACHE_BLOCK_CACHE.
Definition: namecache.h:99
Response to a request to cache a block.
Definition: namecache.h:114
int32_t op_result
GNUNET_OK on success, GNUNET_SYSERR error
Definition: namecache.h:123
struct GNUNET_NAMECACHE_Header gns_header
Type will be GNUNET_MESSAGE_TYPE_NAMECACHE_BLOCK_CACHE_RESPONSE.
Definition: namecache.h:118
uint32_t type
The zone type (GNUNET_GNSRECORD_TYPE_PKEY)
Handle to a message queue.
Definition: mq.c:87
uint32_t r_id
Request ID in NBO.
Definition: namecache.h:51
struct GNUNET_MessageHeader header
header.type will be GNUNET_MESSAGE_TYPE_NAMECACHE_* header.size will be message size
Definition: namecache.h:46
struct returned by the initialization function of the plugin
int(* lookup_block)(void *cls, const struct GNUNET_HashCode *query, GNUNET_NAMECACHE_BlockCallback iter, void *iter_cls)
Get the block for a particular zone and label in the datastore.
int(* cache_block)(void *cls, const struct GNUNET_GNSRECORD_Block *block)
Cache a block in the datastore.
void * cls
Closure to pass to all plugin functions.
Handle to a client that is connected to a service.
Definition: service.c:249
Handle to a service.
Definition: service.c:116
Handle for the service.
Context for name lookups passed from handle_lookup_block to handle_lookup_block_it as closure.
struct NamecacheClient * nc
The client to send the response to.
uint32_t request_id
Operation id for the name lookup.
Lookup a block in the namecache.
Definition: namecache.h:59
struct GNUNET_NAMECACHE_Header gns_header
Type will be GNUNET_MESSAGE_TYPE_NAMECACHE_LOOKUP_BLOCK.
Definition: namecache.h:63
struct GNUNET_HashCode query
The query.
Definition: namecache.h:68
Lookup response.
Definition: namecache.h:76
struct GNUNET_TIME_AbsoluteNBO expire
Expiration time.
Definition: namecache.h:85
struct GNUNET_NAMECACHE_Header gns_header
Type will be GNUNET_MESSAGE_TYPE_NAMECACHE_LOOKUP_BLOCK_RESPONSE.
Definition: namecache.h:80
A namecache client.
struct GNUNET_MQ_Handle * mq
The message queue to talk to client.
struct GNUNET_SERVICE_Client * client
The client.