GNUnet  0.19.3
plugin_namecache_postgres.c
Go to the documentation of this file.
1 /*
2  * This file is part of GNUnet
3  * Copyright (C) 2009-2013, 2016, 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  */
20 
26 #include "platform.h"
29 #include "gnunet_gnsrecord_lib.h"
30 #include "gnunet_pq_lib.h"
31 #include "namecache.h"
32 
33 
34 #define LOG(kind, ...) GNUNET_log_from (kind, "namecache-postgres", __VA_ARGS__)
35 
36 
40 struct Plugin
41 {
42  const struct GNUNET_CONFIGURATION_Handle *cfg;
43 
47  struct GNUNET_PQ_Context *dbh;
48 };
49 
50 
59 static enum GNUNET_GenericReturnValue
61 {
62  struct GNUNET_PQ_PreparedStatement ps[] = {
63  GNUNET_PQ_make_prepare ("cache_block",
64  "INSERT INTO namecache.ns096blocks"
65  " (query, block, expiration_time)"
66  " VALUES"
67  " ($1, $2, $3)"),
68  GNUNET_PQ_make_prepare ("expire_blocks",
69  "DELETE FROM namecache.ns096blocks"
70  " WHERE expiration_time<$1"),
71  GNUNET_PQ_make_prepare ("delete_block",
72  "DELETE FROM namecache.ns096blocks"
73  " WHERE query=$1 AND expiration_time<=$2"),
74  GNUNET_PQ_make_prepare ("lookup_block",
75  "SELECT block"
76  " FROM namecache.ns096blocks"
77  " WHERE query=$1"
78  " ORDER BY expiration_time DESC LIMIT 1"),
80  };
81 
83  "namecache-postgres",
84  "namecache-",
85  NULL,
86  ps);
87  if (NULL == plugin->dbh)
88  return GNUNET_SYSERR;
89  return GNUNET_OK;
90 }
91 
92 
98 static void
100 {
102  struct GNUNET_PQ_QueryParam params[] = {
105  };
107 
109  "expire_blocks",
110  params);
112 }
113 
114 
122 static void
124  const struct GNUNET_HashCode *query,
125  struct GNUNET_TIME_Absolute expiration_time)
126 {
127  struct GNUNET_PQ_QueryParam params[] = {
129  GNUNET_PQ_query_param_absolute_time (&expiration_time),
131  };
133 
135  "delete_block",
136  params);
138 }
139 
140 
148 static enum GNUNET_GenericReturnValue
150  const struct GNUNET_GNSRECORD_Block *block)
151 {
152  struct Plugin *plugin = cls;
153  struct GNUNET_HashCode query;
154  size_t block_size = GNUNET_GNSRECORD_block_get_size (block);
155  struct GNUNET_TIME_Absolute exp;
157  struct GNUNET_PQ_QueryParam params[] = {
159  GNUNET_PQ_query_param_fixed_size (block, block_size),
162  };
164 
167  &query);
168  if (block_size > 64 * 65536)
169  {
170  GNUNET_break (0);
171  return GNUNET_SYSERR;
172  }
174  &query,
175  exp);
176 
178  "cache_block",
179  params);
180  if (0 > res)
181  return GNUNET_SYSERR;
182  return GNUNET_OK;
183 }
184 
185 
196 static enum GNUNET_GenericReturnValue
198  const struct GNUNET_HashCode *query,
200  void *iter_cls)
201 {
202  struct Plugin *plugin = cls;
203  size_t bsize;
204  struct GNUNET_GNSRECORD_Block *block;
205  struct GNUNET_PQ_QueryParam params[] = {
208  };
209  struct GNUNET_PQ_ResultSpec rs[] = {
211  (void **) &block,
212  &bsize),
214  };
216 
218  "lookup_block",
219  params,
220  rs);
221  if (0 > res)
222  {
224  "Failing lookup block in namecache (postgres error)\n");
225  return GNUNET_SYSERR;
226  }
228  {
229  /* no result */
231  "Ending iteration (no more results)\n");
232  return GNUNET_NO;
233  }
234  if ((bsize < sizeof(*block)))
235  {
236  GNUNET_break (0);
238  "Failing lookup (corrupt block)\n");
240  return GNUNET_SYSERR;
241  }
242  iter (iter_cls,
243  block);
245  return GNUNET_OK;
246 }
247 
248 
255 static void
257 {
259  plugin->dbh = NULL;
260 }
261 
262 
269 void *
271 {
272  static struct Plugin plugin;
273  const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
275 
276  if (NULL != plugin.cfg)
277  return NULL; /* can only initialize once! */
278  memset (&plugin, 0, sizeof(struct Plugin));
279  plugin.cfg = cfg;
280  if (GNUNET_OK != database_setup (&plugin))
281  {
283  return NULL;
284  }
286  api->cls = &plugin;
290  "Postgres namecache plugin running\n");
291  return api;
292 }
293 
294 
301 void *
303 {
305  struct Plugin *plugin = api->cls;
306 
308  plugin->cfg = NULL;
309  GNUNET_free (api);
311  "Postgres namecache plugin is finished\n");
312  return NULL;
313 }
314 
315 
316 /* end of plugin_namecache_postgres.c */
static const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration we are using.
Definition: gnunet-abd.c:36
static int res
struct TestcasePlugin * plugin
The process handle to the testbed service.
static unsigned int bsize
GNUNET_DB_QueryStatus
Status code returned from functions running database commands.
Definition: gnunet_db_lib.h:37
@ GNUNET_DB_STATUS_HARD_ERROR
A hard error occurred, retrying will not help.
Definition: gnunet_db_lib.h:41
@ GNUNET_DB_STATUS_SUCCESS_NO_RESULTS
The transaction succeeded, but yielded zero results.
Definition: gnunet_db_lib.h:55
API that can be used to manipulate GNS record data.
Plugin API for the namecache database backend.
API that can be used to store naming information on a GNUnet node.
helper functions for Postgres DB interactions
struct GNUNET_PQ_QueryParam GNUNET_PQ_query_param_fixed_size(const void *ptr, size_t ptr_size)
Generate query parameter for a buffer ptr of ptr_size bytes.
#define GNUNET_PQ_query_param_auto_from_type(x)
Generate fixed-size query parameter with size determined by variable type.
enum GNUNET_DB_QueryStatus GNUNET_PQ_eval_prepared_singleton_select(struct GNUNET_PQ_Context *db, const char *statement_name, const struct GNUNET_PQ_QueryParam *params, struct GNUNET_PQ_ResultSpec *rs)
Execute a named prepared statement that is a SELECT statement which must return a single result in co...
Definition: pq_eval.c:199
struct GNUNET_PQ_QueryParam GNUNET_PQ_query_param_absolute_time(const struct GNUNET_TIME_Absolute *x)
Generate query parameter for an absolute time value.
void GNUNET_PQ_disconnect(struct GNUNET_PQ_Context *db)
Disconnect from the database, destroying the prepared statements and releasing other associated resou...
Definition: pq_connect.c:542
struct GNUNET_PQ_Context * GNUNET_PQ_connect_with_cfg(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *load_path_suffix, const struct GNUNET_PQ_ExecuteStatement *es, const struct GNUNET_PQ_PreparedStatement *ps)
Connect to a postgres database using the configuration option "CONFIG" in section.
Definition: pq_connect.c:477
struct GNUNET_PQ_PreparedStatement GNUNET_PQ_make_prepare(const char *name, const char *sql)
Create a struct GNUNET_PQ_PreparedStatement.
Definition: pq_prepare.c:30
#define GNUNET_PQ_query_param_end
End of query parameter specification.
Definition: gnunet_pq_lib.h:98
struct GNUNET_PQ_ResultSpec GNUNET_PQ_result_spec_variable_size(const char *name, void **dst, size_t *sptr)
Variable-size result expected.
void GNUNET_PQ_cleanup_result(struct GNUNET_PQ_ResultSpec *rs)
Free all memory that was allocated in rs during GNUNET_PQ_extract_result().
Definition: pq.c:122
#define GNUNET_PQ_PREPARED_STATEMENT_END
Terminator for prepared statement list.
enum GNUNET_DB_QueryStatus GNUNET_PQ_eval_prepared_non_select(struct GNUNET_PQ_Context *db, const char *statement_name, const struct GNUNET_PQ_QueryParam *params)
Execute a named prepared statement that is NOT a SELECT statement in connection using the given param...
Definition: pq_eval.c:135
#define GNUNET_PQ_result_spec_end
End of result parameter specification.
size_t GNUNET_GNSRECORD_block_get_size(const struct GNUNET_GNSRECORD_Block *block)
Returns the length of this block in bytes.
enum GNUNET_GenericReturnValue GNUNET_GNSRECORD_query_from_block(const struct GNUNET_GNSRECORD_Block *block, struct GNUNET_HashCode *query)
Builds the query hash from a block.
struct GNUNET_TIME_Absolute GNUNET_GNSRECORD_block_get_expiration(const struct GNUNET_GNSRECORD_Block *block)
Returns the expiration of a block.
GNUNET_GenericReturnValue
Named constants for return values.
@ 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_WARNING
@ GNUNET_ERROR_TYPE_DEBUG
@ GNUNET_ERROR_TYPE_INFO
#define GNUNET_new(type)
Allocate a struct or union of the given type.
#define GNUNET_free(ptr)
Wrapper around free.
void(* GNUNET_NAMECACHE_BlockCallback)(void *cls, const struct GNUNET_GNSRECORD_Block *block)
Function called for matching blocks.
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get(void)
Get the current time.
Definition: time.c:111
common internal definitions for namecache service
static enum GNUNET_GenericReturnValue database_setup(struct Plugin *plugin)
Initialize the database connections and associated data structures (create tables and indices as need...
static enum GNUNET_GenericReturnValue namecache_postgres_cache_block(void *cls, const struct GNUNET_GNSRECORD_Block *block)
Cache a block in the datastore.
static void database_shutdown(struct Plugin *plugin)
Shutdown database connection and associate data structures.
void * libgnunet_plugin_namecache_postgres_done(void *cls)
Exit point from the plugin.
void * libgnunet_plugin_namecache_postgres_init(void *cls)
Entry point for the plugin.
static void delete_old_block(struct Plugin *plugin, const struct GNUNET_HashCode *query, struct GNUNET_TIME_Absolute expiration_time)
Delete older block in the datastore.
static void namecache_postgres_expire_blocks(struct Plugin *plugin)
Removes any expired block.
#define LOG(kind,...)
static enum GNUNET_GenericReturnValue namecache_postgres_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.
void * cls
Closure for all of the callbacks.
A 512-bit hashcode.
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 Postgres database.
Definition: pq.h:36
Information needed to prepare a list of SQL statements using GNUNET_PQ_prepare_statements().
Description of a DB query parameter.
Definition: gnunet_pq_lib.h:66
Description of a DB result cell.
void * cls
Closure for conv and cleaner.
Time for absolute times used by GNUnet, in microseconds.
Handle for a plugin.
Definition: block.c:38
struct GNUNET_BLOCK_PluginFunctions * api
Plugin API.
Definition: block.c:47
struct GNUNET_PQ_Context * dbh
Native Postgres database handle.
const struct GNUNET_CONFIGURATION_Handle * cfg
Our configuration.