GNUnet  0.11.x
Data Structures | Macros | Functions
plugin_datacache_postgres.c File Reference

postgres for an implementation of a database backend for the datacache More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_pq_lib.h"
#include "gnunet_datacache_plugin.h"
Include dependency graph for plugin_datacache_postgres.c:

Go to the source code of this file.

Data Structures

struct  Plugin
 Handle for a plugin. More...
 
struct  HandleResultContext
 Closure for handle_results. More...
 
struct  ExtractResultContext
 Closure for extract_result_cb. More...
 

Macros

#define LOG(kind, ...)   GNUNET_log_from (kind, "datacache-postgres", __VA_ARGS__)
 
#define OVERHEAD   (sizeof(struct GNUNET_HashCode) + 24)
 Per-entry overhead estimate. More...
 

Functions

static int init_connection (struct Plugin *plugin)
 Get a database handle. More...
 
static ssize_t postgres_plugin_put (void *cls, const struct GNUNET_HashCode *key, uint32_t prox, 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. More...
 
static void handle_results (void *cls, PGresult *result, unsigned int num_results)
 Function to be called with the results of a SELECT statement that has returned num_results results. More...
 
static unsigned int postgres_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. More...
 
static int postgres_plugin_del (void *cls)
 Delete the entry with the lowest expiration value from the datacache right now. More...
 
static unsigned int postgres_plugin_get_random (void *cls, GNUNET_DATACACHE_Iterator iter, void *iter_cls)
 Obtain a random key-value pair from the datacache. More...
 
static void extract_result_cb (void *cls, PGresult *result, unsigned int num_results)
 Function to be called with the results of a SELECT statement that has returned num_results results. More...
 
static unsigned int postgres_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. More...
 
void * libgnunet_plugin_datacache_postgres_init (void *cls)
 Entry point for the plugin. More...
 
void * libgnunet_plugin_datacache_postgres_done (void *cls)
 Exit point from the plugin. More...
 

Detailed Description

postgres for an implementation of a database backend for the datacache

Author
Christian Grothoff

Definition in file plugin_datacache_postgres.c.

Macro Definition Documentation

◆ LOG

#define LOG (   kind,
  ... 
)    GNUNET_log_from (kind, "datacache-postgres", __VA_ARGS__)

◆ OVERHEAD

#define OVERHEAD   (sizeof(struct GNUNET_HashCode) + 24)

Per-entry overhead estimate.

Definition at line 36 of file plugin_datacache_postgres.c.

Referenced by postgres_plugin_del(), and postgres_plugin_put().

Function Documentation

◆ init_connection()

static int init_connection ( struct Plugin plugin)
static

Get a database handle.

Parameters
pluginglobal context
Returns
GNUNET_OK on success, GNUNET_SYSERR on error

Definition at line 67 of file plugin_datacache_postgres.c.

References GNUNET_DATACACHE_PluginEnvironment::cfg, Plugin::dbh, Plugin::env, GNUNET_OK, GNUNET_PQ_connect_with_cfg(), GNUNET_PQ_EXECUTE_STATEMENT_END, GNUNET_PQ_make_execute(), GNUNET_PQ_make_prepare(), GNUNET_PQ_make_try_execute(), GNUNET_PQ_PREPARED_STATEMENT_END, and GNUNET_SYSERR.

Referenced by libgnunet_plugin_datacache_postgres_init().

68 {
69  struct GNUNET_PQ_ExecuteStatement es[] = {
70  GNUNET_PQ_make_try_execute ("CREATE TEMPORARY SEQUENCE IF NOT EXISTS gn011dc_oid_seq"),
71  GNUNET_PQ_make_execute ("CREATE TEMPORARY TABLE IF NOT EXISTS gn011dc ("
72  " oid OID NOT NULL DEFAULT nextval('gn011dc_oid_seq'),"
73  " type INTEGER NOT NULL,"
74  " prox INTEGER NOT NULL,"
75  " discard_time BIGINT NOT NULL,"
76  " key BYTEA NOT NULL,"
77  " value BYTEA NOT NULL,"
78  " path BYTEA DEFAULT NULL)"),
80  "ALTER SEQUENCE gnu011dc_oid_seq OWNED BY gn011dc.oid"),
82  "CREATE INDEX IF NOT EXISTS idx_oid ON gn011dc (oid)"),
84  "CREATE INDEX IF NOT EXISTS idx_key ON gn011dc (key)"),
86  "CREATE INDEX IF NOT EXISTS idx_dt ON gn011dc (discard_time)"),
88  "ALTER TABLE gn011dc ALTER value SET STORAGE EXTERNAL"),
89  GNUNET_PQ_make_execute ("ALTER TABLE gn011dc ALTER key SET STORAGE PLAIN"),
91  };
92  struct GNUNET_PQ_PreparedStatement ps[] = {
93  GNUNET_PQ_make_prepare ("getkt",
94  "SELECT discard_time,type,value,path FROM gn011dc "
95  "WHERE key=$1 AND type=$2 AND discard_time >= $3",
96  3),
97  GNUNET_PQ_make_prepare ("getk",
98  "SELECT discard_time,type,value,path FROM gn011dc "
99  "WHERE key=$1 AND discard_time >= $2",
100  2),
101  GNUNET_PQ_make_prepare ("getex",
102  "SELECT length(value) AS len,oid,key FROM gn011dc"
103  " WHERE discard_time < $1"
104  " ORDER BY discard_time ASC LIMIT 1",
105  1),
106  GNUNET_PQ_make_prepare ("getm",
107  "SELECT length(value) AS len,oid,key FROM gn011dc"
108  " ORDER BY prox ASC, discard_time ASC LIMIT 1",
109  0),
110  GNUNET_PQ_make_prepare ("get_random",
111  "SELECT discard_time,type,value,path,key FROM gn011dc"
112  " WHERE discard_time >= $1"
113  " ORDER BY key ASC LIMIT 1 OFFSET $2",
114  2),
115  GNUNET_PQ_make_prepare ("get_closest",
116  "SELECT discard_time,type,value,path,key FROM gn011dc "
117  "WHERE key>=$1 AND discard_time >= $2 ORDER BY key ASC LIMIT $3",
118  3),
119  GNUNET_PQ_make_prepare ("delrow",
120  "DELETE FROM gn011dc WHERE oid=$1",
121  1),
122  GNUNET_PQ_make_prepare ("put",
123  "INSERT INTO gn011dc (type, prox, discard_time, key, value, path) "
124  "VALUES ($1, $2, $3, $4, $5, $6)",
125  6),
127  };
128 
129  plugin->dbh = GNUNET_PQ_connect_with_cfg (plugin->env->cfg,
130  "datacache-postgres",
131  NULL,
132  es,
133  ps);
134  if (NULL == plugin->dbh)
135  return GNUNET_SYSERR;
136  return GNUNET_OK;
137 }
struct GNUNET_PQ_ExecuteStatement GNUNET_PQ_make_execute(const char *sql)
Create a struct GNUNET_PQ_ExecuteStatement where errors are fatal.
Definition: pq_exec.c:36
const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration to use.
Information needed to run a list of SQL statements using GNUNET_PQ_exec_statements().
Information needed to prepare a list of SQL statements using GNUNET_PQ_prepare_statements().
struct GNUNET_DATACACHE_PluginEnvironment * env
Our execution environment.
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:469
#define GNUNET_PQ_PREPARED_STATEMENT_END
Terminator for prepared statement list.
struct GNUNET_PQ_Context * dbh
Native Postgres database handle.
#define GNUNET_PQ_EXECUTE_STATEMENT_END
Terminator for executable statement list.
struct GNUNET_PQ_ExecuteStatement GNUNET_PQ_make_try_execute(const char *sql)
Create a struct GNUNET_PQ_ExecuteStatement where errors should be tolerated.
Definition: pq_exec.c:55
struct GNUNET_PQ_PreparedStatement GNUNET_PQ_make_prepare(const char *name, const char *sql, unsigned int num_args)
Create a struct GNUNET_PQ_PreparedStatement.
Definition: pq_prepare.c:38
Here is the call graph for this function:
Here is the caller graph for this function:

◆ postgres_plugin_put()

static ssize_t postgres_plugin_put ( void *  cls,
const struct GNUNET_HashCode key,
uint32_t  prox,
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 
)
static

Store an item in the datastore.

Parameters
clsclosure (our struct Plugin)
keykey to store data under
proxproximity of key to my PID
data_sizenumber of bytes in data
datadata to store
typetype of the value
discard_timewhen to discard the value in any case
path_info_lennumber of entries in path_info
path_infoa path through the network
Returns
0 if duplicate, -1 on error, number of bytes used otherwise

Definition at line 155 of file plugin_datacache_postgres.c.

References Plugin::dbh, GNUNET_PQ_eval_prepared_non_select(), GNUNET_PQ_query_param_absolute_time(), GNUNET_PQ_query_param_auto_from_type, GNUNET_PQ_query_param_end, GNUNET_PQ_query_param_fixed_size(), GNUNET_PQ_query_param_uint32(), Plugin::num_items, OVERHEAD, plugin, and ret.

Referenced by libgnunet_plugin_datacache_postgres_init().

164 {
165  struct Plugin *plugin = cls;
166  uint32_t type32 = (uint32_t) type;
167  struct GNUNET_PQ_QueryParam params[] = {
170  GNUNET_PQ_query_param_absolute_time (&discard_time),
174  path_info_len * sizeof(struct
177  };
179 
181  "put",
182  params);
183  if (0 > ret)
184  return -1;
185  plugin->num_items++;
186  return data_size + OVERHEAD;
187 }
static size_t data_size
Number of bytes in data.
Definition: gnunet-abd.c:187
static int ret
Return value of the commandline.
Definition: gnunet-abd.c:81
struct GNUNET_PQ_QueryParam GNUNET_PQ_query_param_absolute_time(const struct GNUNET_TIME_Absolute *x)
Generate query parameter for an absolute time value.
#define OVERHEAD
Per-entry overhead estimate.
#define GNUNET_PQ_query_param_end
End of query parameter specification.
Definition: gnunet_pq_lib.h:97
#define GNUNET_PQ_query_param_auto_from_type(x)
Generate fixed-size query parameter with size determined by variable type.
struct GNUNET_PQ_QueryParam GNUNET_PQ_query_param_uint32(const uint32_t *x)
Generate query parameter for an uint32_t in host byte order.
static char * plugin
Solver plugin name as string.
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:164
The identity of the host (wraps the signing key of the peer).
Handle for a plugin.
Definition: block.c:37
struct GNUNET_PQ_Context * dbh
Native Postgres database handle.
Description of a DB query parameter.
Definition: gnunet_pq_lib.h:64
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.
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model
GNUNET_DB_QueryStatus
Status code returned from functions running database commands.
Definition: gnunet_db_lib.h:34
unsigned int num_items
Number of key-value pairs in the database.
uint32_t data
The data value.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ handle_results()

static void handle_results ( void *  cls,
PGresult *  result,
unsigned int  num_results 
)
static

Function to be called with the results of a SELECT statement that has returned num_results results.

Parse the result and call the callback given in cls

Parameters
clsclosure of type struct HandleResultContext
resultthe postgres result
num_resultthe number of results in result

Definition at line 222 of file plugin_datacache_postgres.c.

References data, data_size, GNUNET_break, GNUNET_ERROR_TYPE_DEBUG, GNUNET_PQ_cleanup_result(), GNUNET_PQ_extract_result(), GNUNET_PQ_result_spec_absolute_time(), GNUNET_PQ_result_spec_end, GNUNET_PQ_result_spec_uint32(), GNUNET_PQ_result_spec_variable_size(), GNUNET_SYSERR, GNUNET_YES, HandleResultContext::iter, HandleResultContext::iter_cls, HandleResultContext::key, LOG, and type.

Referenced by postgres_plugin_get().

225 {
226  struct HandleResultContext *hrc = cls;
227 
228  for (unsigned int i = 0; i < num_results; i++)
229  {
230  struct GNUNET_TIME_Absolute expiration_time;
231  uint32_t type;
232  void *data;
233  size_t data_size;
234  struct GNUNET_PeerIdentity *path;
235  size_t path_len;
236  struct GNUNET_PQ_ResultSpec rs[] = {
237  GNUNET_PQ_result_spec_absolute_time ("discard_time",
238  &expiration_time),
240  &type),
242  &data,
243  &data_size),
245  (void **) &path,
246  &path_len),
248  };
249 
250  if (GNUNET_YES !=
252  rs,
253  i))
254  {
255  GNUNET_break (0);
256  return;
257  }
258  if (0 != (path_len % sizeof(struct GNUNET_PeerIdentity)))
259  {
260  GNUNET_break (0);
261  path_len = 0;
262  }
263  path_len %= sizeof(struct GNUNET_PeerIdentity);
265  "Found result of size %u bytes and type %u in database\n",
266  (unsigned int) data_size,
267  (unsigned int) type);
268  if ((NULL != hrc->iter) &&
269  (GNUNET_SYSERR ==
270  hrc->iter (hrc->iter_cls,
271  hrc->key,
272  data_size,
273  data,
274  (enum GNUNET_BLOCK_Type) type,
275  expiration_time,
276  path_len,
277  path)))
278  {
280  "Ending iteration (client error)\n");
282  return;
283  }
285  }
286 }
void * iter_cls
Closure for iter.
GNUNET_BLOCK_Type
Blocks in the datastore and the datacache must have a unique type.
#define LOG(kind,...)
static size_t data_size
Number of bytes in data.
Definition: gnunet-abd.c:187
Description of a DB result cell.
Closure for handle_results.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
#define GNUNET_PQ_result_spec_end
End of result parameter specification.
struct GNUNET_PQ_ResultSpec GNUNET_PQ_result_spec_variable_size(const char *name, void **dst, size_t *sptr)
Variable-size result expected.
struct GNUNET_PQ_ResultSpec GNUNET_PQ_result_spec_uint32(const char *name, uint32_t *u32)
uint32_t expected.
struct GNUNET_PQ_ResultSpec GNUNET_PQ_result_spec_absolute_time(const char *name, struct GNUNET_TIME_Absolute *at)
Absolute time expected.
static int result
Global testing status.
GNUNET_DATACACHE_Iterator iter
Function to call on each result, may be NULL.
The identity of the host (wraps the signing key of the peer).
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model
Time for absolute times used by GNUnet, in microseconds.
uint32_t data
The data value.
const struct GNUNET_HashCode * key
Key used.
int GNUNET_PQ_extract_result(PGresult *result, struct GNUNET_PQ_ResultSpec *rs, int row)
Extract results from a query result according to the given specification.
Definition: pq.c:127
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:117
Here is the call graph for this function:
Here is the caller graph for this function:

◆ postgres_plugin_get()

static unsigned int postgres_plugin_get ( void *  cls,
const struct GNUNET_HashCode key,
enum GNUNET_BLOCK_Type  type,
GNUNET_DATACACHE_Iterator  iter,
void *  iter_cls 
)
static

Iterate over the results for a particular key in the datastore.

Parameters
clsclosure (our struct Plugin)
keykey to look for
typeentries of which type are relevant?
itermaybe NULL (to just count)
iter_clsclosure for iter
Returns
the number of results found

Definition at line 301 of file plugin_datacache_postgres.c.

References Plugin::dbh, GNUNET_PQ_eval_prepared_multi_select(), GNUNET_PQ_query_param_absolute_time(), GNUNET_PQ_query_param_auto_from_type, GNUNET_PQ_query_param_end, GNUNET_PQ_query_param_uint32(), GNUNET_TIME_absolute_get(), handle_results(), Plugin::iter, HandleResultContext::iter, Plugin::iter_cls, HandleResultContext::iter_cls, Plugin::key, HandleResultContext::key, plugin, and res.

Referenced by libgnunet_plugin_datacache_postgres_init().

306 {
307  struct Plugin *plugin = cls;
308  uint32_t type32 = (uint32_t) type;
309  struct GNUNET_TIME_Absolute now;
310  struct GNUNET_PQ_QueryParam paramk[] = {
314  };
315  struct GNUNET_PQ_QueryParam paramkt[] = {
320  };
322  struct HandleResultContext hr_ctx;
323 
324  now = GNUNET_TIME_absolute_get ();
325  hr_ctx.iter = iter;
326  hr_ctx.iter_cls = iter_cls;
327  hr_ctx.key = key;
329  (0 == type) ? "getk" : "getkt",
330  (0 == type) ? paramk : paramkt,
332  &hr_ctx);
333  if (res < 0)
334  return 0;
335  return res;
336 }
void * iter_cls
Closure for iter.
enum GNUNET_DB_QueryStatus GNUNET_PQ_eval_prepared_multi_select(struct GNUNET_PQ_Context *db, const char *statement_name, const struct GNUNET_PQ_QueryParam *params, GNUNET_PQ_PostgresResultHandler rh, void *rh_cls)
Execute a named prepared statement that is a SELECT statement which may return multiple results in co...
Definition: pq_eval.c:209
Closure for handle_results.
struct GNUNET_PQ_QueryParam GNUNET_PQ_query_param_absolute_time(const struct GNUNET_TIME_Absolute *x)
Generate query parameter for an absolute time value.
#define GNUNET_PQ_query_param_end
End of query parameter specification.
Definition: gnunet_pq_lib.h:97
#define GNUNET_PQ_query_param_auto_from_type(x)
Generate fixed-size query parameter with size determined by variable type.
struct GNUNET_PQ_QueryParam GNUNET_PQ_query_param_uint32(const uint32_t *x)
Generate query parameter for an uint32_t in host byte order.
static void handle_results(void *cls, PGresult *result, unsigned int num_results)
Function to be called with the results of a SELECT statement that has returned num_results results...
static int res
static char * plugin
Solver plugin name as string.
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get(void)
Get the current time.
Definition: time.c:118
struct GNUNET_HashCode key
The key used in the DHT.
GNUNET_DATACACHE_Iterator iter
Function to call on each result, may be NULL.
Handle for a plugin.
Definition: block.c:37
struct GNUNET_PQ_Context * dbh
Native Postgres database handle.
Description of a DB query parameter.
Definition: gnunet_pq_lib.h:64
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model
Time for absolute times used by GNUnet, in microseconds.
GNUNET_DB_QueryStatus
Status code returned from functions running database commands.
Definition: gnunet_db_lib.h:34
Here is the call graph for this function:
Here is the caller graph for this function:

◆ postgres_plugin_del()

static int postgres_plugin_del ( void *  cls)
static

Delete the entry with the lowest expiration value from the datacache right now.

Parameters
clsclosure (our struct Plugin)
Returns
GNUNET_OK on success, GNUNET_SYSERR on error

Definition at line 347 of file plugin_datacache_postgres.c.

References GNUNET_DATACACHE_PluginEnvironment::cls, Plugin::dbh, GNUNET_DATACACHE_PluginEnvironment::delete_notify, Plugin::env, GNUNET_DB_STATUS_SUCCESS_NO_RESULTS, GNUNET_ERROR_TYPE_DEBUG, GNUNET_OK, GNUNET_PQ_cleanup_result(), GNUNET_PQ_eval_prepared_non_select(), GNUNET_PQ_eval_prepared_singleton_select(), GNUNET_PQ_query_param_absolute_time(), GNUNET_PQ_query_param_end, GNUNET_PQ_query_param_uint32(), GNUNET_PQ_result_spec_auto_from_type, GNUNET_PQ_result_spec_end, GNUNET_PQ_result_spec_uint32(), GNUNET_SYSERR, GNUNET_TIME_absolute_get(), LOG, Plugin::num_items, OVERHEAD, plugin, res, and Plugin::size.

Referenced by libgnunet_plugin_datacache_postgres_init().

348 {
349  struct Plugin *plugin = cls;
350  struct GNUNET_PQ_QueryParam pempty[] = {
352  };
353  uint32_t size;
354  uint32_t oid;
355  struct GNUNET_HashCode key;
356  struct GNUNET_PQ_ResultSpec rs[] = {
358  &size),
360  &oid),
362  &key),
364  };
366  struct GNUNET_PQ_QueryParam dparam[] = {
369  };
370  struct GNUNET_TIME_Absolute now;
371  struct GNUNET_PQ_QueryParam xparam[] = {
374  };
375 
376  now = GNUNET_TIME_absolute_get ();
378  "getex",
379  xparam,
380  rs);
381  if (0 >= res)
383  "getm",
384  pempty,
385  rs);
386  if (0 > res)
387  return GNUNET_SYSERR;
389  {
390  /* no result */
392  "Ending iteration (no more results)\n");
393  return 0;
394  }
396  "delrow",
397  dparam);
398  if (0 > res)
399  {
401  return GNUNET_SYSERR;
402  }
403  plugin->num_items--;
404  plugin->env->delete_notify (plugin->env->cls,
405  &key,
406  size + OVERHEAD);
408  return GNUNET_OK;
409 }
#define LOG(kind,...)
Description of a DB result cell.
struct GNUNET_PQ_QueryParam GNUNET_PQ_query_param_absolute_time(const struct GNUNET_TIME_Absolute *x)
Generate query parameter for an absolute time value.
GNUNET_DATACACHE_DeleteNotifyCallback delete_notify
Function to call whenever the plugin needs to discard content that it was asked to store...
#define OVERHEAD
Per-entry overhead estimate.
#define GNUNET_PQ_result_spec_end
End of result parameter specification.
#define GNUNET_PQ_query_param_end
End of query parameter specification.
Definition: gnunet_pq_lib.h:97
struct GNUNET_PQ_ResultSpec GNUNET_PQ_result_spec_uint32(const char *name, uint32_t *u32)
uint32_t expected.
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:258
struct GNUNET_DATACACHE_PluginEnvironment * env
Our execution environment.
struct GNUNET_PQ_QueryParam GNUNET_PQ_query_param_uint32(const uint32_t *x)
Generate query parameter for an uint32_t in host byte order.
A 512-bit hashcode.
static int res
static char * plugin
Solver plugin name as string.
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get(void)
Get the current time.
Definition: time.c:118
#define GNUNET_PQ_result_spec_auto_from_type(name, dst)
We expect a fixed-size result, with size determined by the type of * dst
struct GNUNET_HashCode key
The key used in the DHT.
static unsigned int size
Size of the "table".
Definition: peer.c:67
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:164
Handle for a plugin.
Definition: block.c:37
struct GNUNET_PQ_Context * dbh
Native Postgres database handle.
Description of a DB query parameter.
Definition: gnunet_pq_lib.h:64
void * cls
Closure to use for callbacks.
Time for absolute times used by GNUnet, in microseconds.
GNUNET_DB_QueryStatus
Status code returned from functions running database commands.
Definition: gnunet_db_lib.h:34
unsigned int num_items
Number of key-value pairs in the database.
The transaction succeeded, but yielded zero results.
Definition: gnunet_db_lib.h:53
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:117
Here is the call graph for this function:
Here is the caller graph for this function:

◆ postgres_plugin_get_random()

static unsigned int postgres_plugin_get_random ( void *  cls,
GNUNET_DATACACHE_Iterator  iter,
void *  iter_cls 
)
static

Obtain a random key-value pair from the datacache.

Parameters
clsclosure (our struct Plugin)
itermaybe NULL (to just count)
iter_clsclosure for iter
Returns
the number of results found, zero (datacache empty) or one

Definition at line 421 of file plugin_datacache_postgres.c.

References data, data_size, Plugin::dbh, GNUNET_break, GNUNET_CRYPTO_QUALITY_NONCE, GNUNET_CRYPTO_random_u32(), GNUNET_DB_STATUS_SUCCESS_NO_RESULTS, GNUNET_ERROR_TYPE_DEBUG, GNUNET_h2s(), GNUNET_PQ_cleanup_result(), GNUNET_PQ_eval_prepared_singleton_select(), GNUNET_PQ_query_param_absolute_time(), GNUNET_PQ_query_param_end, GNUNET_PQ_query_param_uint32(), GNUNET_PQ_result_spec_absolute_time(), GNUNET_PQ_result_spec_auto_from_type, GNUNET_PQ_result_spec_end, GNUNET_PQ_result_spec_uint32(), GNUNET_PQ_result_spec_variable_size(), GNUNET_TIME_absolute_get(), LOG, Plugin::num_items, plugin, res, and type.

Referenced by libgnunet_plugin_datacache_postgres_init().

424 {
425  struct Plugin *plugin = cls;
426  uint32_t off;
427  struct GNUNET_TIME_Absolute now;
428  struct GNUNET_TIME_Absolute expiration_time;
429  size_t data_size;
430  void *data;
431  size_t path_len;
432  struct GNUNET_PeerIdentity *path;
433  struct GNUNET_HashCode key;
434  uint32_t type;
436  struct GNUNET_PQ_QueryParam params[] = {
440  };
441  struct GNUNET_PQ_ResultSpec rs[] = {
442  GNUNET_PQ_result_spec_absolute_time ("discard_time",
443  &expiration_time),
445  &type),
447  &data,
448  &data_size),
450  (void **) &path,
451  &path_len),
453  &key),
455  };
456 
457  if (0 == plugin->num_items)
458  return 0;
459  if (NULL == iter)
460  return 1;
461  now = GNUNET_TIME_absolute_get ();
463  plugin->num_items);
465  "get_random",
466  params,
467  rs);
468  if (0 > res)
469  {
470  GNUNET_break (0);
471  return 0;
472  }
474  {
475  GNUNET_break (0);
476  return 0;
477  }
478  if (0 != (path_len % sizeof(struct GNUNET_PeerIdentity)))
479  {
480  GNUNET_break (0);
481  path_len = 0;
482  }
483  path_len %= sizeof(struct GNUNET_PeerIdentity);
485  "Found random value with key %s of size %u bytes and type %u in database\n",
486  GNUNET_h2s (&key),
487  (unsigned int) data_size,
488  (unsigned int) type);
489  (void) iter (iter_cls,
490  &key,
491  data_size,
492  data,
493  (enum GNUNET_BLOCK_Type) type,
494  expiration_time,
495  path_len,
496  path);
498  return 1;
499 }
GNUNET_BLOCK_Type
Blocks in the datastore and the datacache must have a unique type.
#define LOG(kind,...)
static size_t data_size
Number of bytes in data.
Definition: gnunet-abd.c:187
uint32_t GNUNET_CRYPTO_random_u32(enum GNUNET_CRYPTO_Quality mode, uint32_t i)
Produce a random value.
Description of a DB result cell.
struct GNUNET_PQ_QueryParam GNUNET_PQ_query_param_absolute_time(const struct GNUNET_TIME_Absolute *x)
Generate query parameter for an absolute time value.
const char * GNUNET_h2s(const struct GNUNET_HashCode *hc)
Convert a hash value to a string (for printing debug messages).
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
#define GNUNET_PQ_result_spec_end
End of result parameter specification.
#define GNUNET_PQ_query_param_end
End of query parameter specification.
Definition: gnunet_pq_lib.h:97
struct GNUNET_PQ_ResultSpec GNUNET_PQ_result_spec_variable_size(const char *name, void **dst, size_t *sptr)
Variable-size result expected.
struct GNUNET_PQ_ResultSpec GNUNET_PQ_result_spec_uint32(const char *name, uint32_t *u32)
uint32_t expected.
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:258
struct GNUNET_PQ_ResultSpec GNUNET_PQ_result_spec_absolute_time(const char *name, struct GNUNET_TIME_Absolute *at)
Absolute time expected.
Randomness for IVs etc.
struct GNUNET_PQ_QueryParam GNUNET_PQ_query_param_uint32(const uint32_t *x)
Generate query parameter for an uint32_t in host byte order.
A 512-bit hashcode.
static int res
static char * plugin
Solver plugin name as string.
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get(void)
Get the current time.
Definition: time.c:118
#define GNUNET_PQ_result_spec_auto_from_type(name, dst)
We expect a fixed-size result, with size determined by the type of * dst
struct GNUNET_HashCode key
The key used in the DHT.
The identity of the host (wraps the signing key of the peer).
Handle for a plugin.
Definition: block.c:37
struct GNUNET_PQ_Context * dbh
Native Postgres database handle.
Description of a DB query parameter.
Definition: gnunet_pq_lib.h:64
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model
Time for absolute times used by GNUnet, in microseconds.
GNUNET_DB_QueryStatus
Status code returned from functions running database commands.
Definition: gnunet_db_lib.h:34
unsigned int num_items
Number of key-value pairs in the database.
The transaction succeeded, but yielded zero results.
Definition: gnunet_db_lib.h:53
uint32_t data
The data value.
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:117
Here is the call graph for this function:
Here is the caller graph for this function:

◆ extract_result_cb()

static void extract_result_cb ( void *  cls,
PGresult *  result,
unsigned int  num_results 
)
static

Function to be called with the results of a SELECT statement that has returned num_results results.

Calls the iter from cls for each result.

Parameters
clsclosure with the struct ExtractResultContext
resultthe postgres result
num_resultthe number of results in result

Definition at line 529 of file plugin_datacache_postgres.c.

References data, data_size, GNUNET_break, GNUNET_ERROR_TYPE_DEBUG, GNUNET_PQ_cleanup_result(), GNUNET_PQ_extract_result(), GNUNET_PQ_result_spec_absolute_time(), GNUNET_PQ_result_spec_auto_from_type, GNUNET_PQ_result_spec_end, GNUNET_PQ_result_spec_uint32(), GNUNET_PQ_result_spec_variable_size(), GNUNET_SYSERR, GNUNET_YES, ExtractResultContext::iter, ExtractResultContext::iter_cls, LOG, and type.

Referenced by postgres_plugin_get_closest().

532 {
533  struct ExtractResultContext *erc = cls;
534 
535  if (NULL == erc->iter)
536  return;
537  for (unsigned int i = 0; i < num_results; i++)
538  {
539  struct GNUNET_TIME_Absolute expiration_time;
540  uint32_t type;
541  void *data;
542  size_t data_size;
543  struct GNUNET_PeerIdentity *path;
544  size_t path_len;
545  struct GNUNET_HashCode key;
546  struct GNUNET_PQ_ResultSpec rs[] = {
548  &expiration_time),
550  &type),
552  &data,
553  &data_size),
555  (void **) &path,
556  &path_len),
558  &key),
560  };
561 
562  if (GNUNET_YES !=
564  rs,
565  i))
566  {
567  GNUNET_break (0);
568  return;
569  }
570  if (0 != (path_len % sizeof(struct GNUNET_PeerIdentity)))
571  {
572  GNUNET_break (0);
573  path_len = 0;
574  }
575  path_len %= sizeof(struct GNUNET_PeerIdentity);
577  "Found result of size %u bytes and type %u in database\n",
578  (unsigned int) data_size,
579  (unsigned int) type);
580  if (GNUNET_SYSERR ==
581  erc->iter (erc->iter_cls,
582  &key,
583  data_size,
584  data,
585  (enum GNUNET_BLOCK_Type) type,
586  expiration_time,
587  path_len,
588  path))
589  {
591  "Ending iteration (client error)\n");
593  break;
594  }
596  }
597 }
void * iter_cls
Closure for iter.
GNUNET_BLOCK_Type
Blocks in the datastore and the datacache must have a unique type.
#define LOG(kind,...)
static size_t data_size
Number of bytes in data.
Definition: gnunet-abd.c:187
Description of a DB result cell.
Closure for extract_result_cb.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
#define GNUNET_PQ_result_spec_end
End of result parameter specification.
struct GNUNET_PQ_ResultSpec GNUNET_PQ_result_spec_variable_size(const char *name, void **dst, size_t *sptr)
Variable-size result expected.
struct GNUNET_PQ_ResultSpec GNUNET_PQ_result_spec_uint32(const char *name, uint32_t *u32)
uint32_t expected.
struct GNUNET_PQ_ResultSpec GNUNET_PQ_result_spec_absolute_time(const char *name, struct GNUNET_TIME_Absolute *at)
Absolute time expected.
static int result
Global testing status.
A 512-bit hashcode.
#define GNUNET_PQ_result_spec_auto_from_type(name, dst)
We expect a fixed-size result, with size determined by the type of * dst
struct GNUNET_HashCode key
The key used in the DHT.
The identity of the host (wraps the signing key of the peer).
GNUNET_DATACACHE_Iterator iter
Function to call for each result found.
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model
Time for absolute times used by GNUnet, in microseconds.
uint32_t data
The data value.
int GNUNET_PQ_extract_result(PGresult *result, struct GNUNET_PQ_ResultSpec *rs, int row)
Extract results from a query result according to the given specification.
Definition: pq.c:127
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:117
Here is the call graph for this function:
Here is the caller graph for this function:

◆ postgres_plugin_get_closest()

static unsigned int postgres_plugin_get_closest ( void *  cls,
const struct GNUNET_HashCode key,
unsigned int  num_results,
GNUNET_DATACACHE_Iterator  iter,
void *  iter_cls 
)
static

Iterate over the results that are "close" to a particular key in the datacache.

"close" is defined as numerically larger than key (when interpreted as a circular address space), with small distance.

Parameters
clsclosure (internal context for the plugin)
keyarea of the keyspace to look into
num_resultsnumber of results that should be returned to iter
itermaybe NULL (to just count)
iter_clsclosure for iter
Returns
the number of results found

Definition at line 614 of file plugin_datacache_postgres.c.

References Plugin::dbh, extract_result_cb(), GNUNET_DB_STATUS_SUCCESS_NO_RESULTS, GNUNET_ERROR_TYPE_DEBUG, GNUNET_PQ_eval_prepared_multi_select(), GNUNET_PQ_query_param_absolute_time(), GNUNET_PQ_query_param_auto_from_type, GNUNET_PQ_query_param_end, GNUNET_PQ_query_param_uint32(), GNUNET_TIME_absolute_get(), Plugin::iter, ExtractResultContext::iter, Plugin::iter_cls, ExtractResultContext::iter_cls, LOG, plugin, and res.

Referenced by libgnunet_plugin_datacache_postgres_init().

619 {
620  struct Plugin *plugin = cls;
621  uint32_t num_results32 = (uint32_t) num_results;
622  struct GNUNET_TIME_Absolute now;
623  struct GNUNET_PQ_QueryParam params[] = {
626  GNUNET_PQ_query_param_uint32 (&num_results32),
628  };
630  struct ExtractResultContext erc;
631 
632  erc.iter = iter;
633  erc.iter_cls = iter_cls;
634  now = GNUNET_TIME_absolute_get ();
636  "get_closest",
637  params,
639  &erc);
640  if (0 > res)
641  {
643  "Ending iteration (postgres error)\n");
644  return 0;
645  }
647  {
648  /* no result */
650  "Ending iteration (no more results)\n");
651  return 0;
652  }
653  return res;
654 }
void * iter_cls
Closure for iter.
#define LOG(kind,...)
enum GNUNET_DB_QueryStatus GNUNET_PQ_eval_prepared_multi_select(struct GNUNET_PQ_Context *db, const char *statement_name, const struct GNUNET_PQ_QueryParam *params, GNUNET_PQ_PostgresResultHandler rh, void *rh_cls)
Execute a named prepared statement that is a SELECT statement which may return multiple results in co...
Definition: pq_eval.c:209
struct GNUNET_PQ_QueryParam GNUNET_PQ_query_param_absolute_time(const struct GNUNET_TIME_Absolute *x)
Generate query parameter for an absolute time value.
Closure for extract_result_cb.
#define GNUNET_PQ_query_param_end
End of query parameter specification.
Definition: gnunet_pq_lib.h:97
static void extract_result_cb(void *cls, PGresult *result, unsigned int num_results)
Function to be called with the results of a SELECT statement that has returned num_results results...
#define GNUNET_PQ_query_param_auto_from_type(x)
Generate fixed-size query parameter with size determined by variable type.
struct GNUNET_PQ_QueryParam GNUNET_PQ_query_param_uint32(const uint32_t *x)
Generate query parameter for an uint32_t in host byte order.
static int res
static char * plugin
Solver plugin name as string.
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get(void)
Get the current time.
Definition: time.c:118
Handle for a plugin.
Definition: block.c:37
struct GNUNET_PQ_Context * dbh
Native Postgres database handle.
GNUNET_DATACACHE_Iterator iter
Function to call for each result found.
Description of a DB query parameter.
Definition: gnunet_pq_lib.h:64
Time for absolute times used by GNUnet, in microseconds.
GNUNET_DB_QueryStatus
Status code returned from functions running database commands.
Definition: gnunet_db_lib.h:34
The transaction succeeded, but yielded zero results.
Definition: gnunet_db_lib.h:53
Here is the call graph for this function:
Here is the caller graph for this function:

◆ libgnunet_plugin_datacache_postgres_init()

void* libgnunet_plugin_datacache_postgres_init ( void *  cls)

Entry point for the plugin.

Parameters
clsclosure (the struct GNUNET_DATACACHE_PluginEnvironmnet)
Returns
the plugin's closure (our struct Plugin)

Definition at line 664 of file plugin_datacache_postgres.c.

References Plugin::api, GNUNET_DATACACHE_PluginEnvironment::cls, GNUNET_DATACACHE_PluginFunctions::cls, GNUNET_DATACACHE_PluginFunctions::del, Plugin::env, GNUNET_DATACACHE_PluginFunctions::get, GNUNET_DATACACHE_PluginFunctions::get_closest, GNUNET_DATACACHE_PluginFunctions::get_random, GNUNET_ERROR_TYPE_INFO, GNUNET_free, GNUNET_new, GNUNET_OK, init_connection(), LOG, plugin, postgres_plugin_del(), postgres_plugin_get(), postgres_plugin_get_closest(), postgres_plugin_get_random(), postgres_plugin_put(), and GNUNET_DATACACHE_PluginFunctions::put.

665 {
668  struct Plugin *plugin;
669 
670  plugin = GNUNET_new (struct Plugin);
671  plugin->env = env;
672 
673  if (GNUNET_OK != init_connection (plugin))
674  {
675  GNUNET_free (plugin);
676  return NULL;
677  }
678 
680  api->cls = plugin;
681  api->get = &postgres_plugin_get;
682  api->put = &postgres_plugin_put;
683  api->del = &postgres_plugin_del;
687  "Postgres datacache running\n");
688  return api;
689 }
void * cls
Closure to pass to all plugin functions.
static unsigned int postgres_plugin_get_random(void *cls, GNUNET_DATACACHE_Iterator iter, void *iter_cls)
Obtain a random key-value pair from the datacache.
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.
static int postgres_plugin_del(void *cls)
Delete the entry with the lowest expiration value from the datacache right now.
#define LOG(kind,...)
#define GNUNET_new(type)
Allocate a struct or union of the given type.
struct GNUNET_BLOCK_PluginFunctions * api
Plugin API.
Definition: block.c:47
static unsigned int postgres_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.
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.
static ssize_t postgres_plugin_put(void *cls, const struct GNUNET_HashCode *key, uint32_t prox, 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.
struct returned by the initialization function of the plugin
static char * plugin
Solver plugin name as string.
struct GNUNET_MQ_Envelope * env
Definition: 005.c:1
Handle for a plugin.
Definition: block.c:37
void * cls
Closure to use for callbacks.
unsigned int(* get_random)(void *cls, GNUNET_DATACACHE_Iterator iter, void *iter_cls)
Return a random value from the datastore.
static int init_connection(struct Plugin *plugin)
Get a database handle.
static unsigned int postgres_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.
The datastore service will pass a pointer to a struct of this type as the first and only argument to ...
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.
Here is the call graph for this function:

◆ libgnunet_plugin_datacache_postgres_done()

void* libgnunet_plugin_datacache_postgres_done ( void *  cls)

Exit point from the plugin.

Parameters
clsclosure (our struct Plugin)
Returns
NULL

Definition at line 699 of file plugin_datacache_postgres.c.

References Plugin::api, GNUNET_DATACACHE_PluginFunctions::cls, Plugin::dbh, GNUNET_free, GNUNET_PQ_disconnect(), and plugin.

700 {
702  struct Plugin *plugin = api->cls;
703 
704  GNUNET_PQ_disconnect (plugin->dbh);
705  GNUNET_free (plugin);
706  GNUNET_free (api);
707  return NULL;
708 }
void * cls
Closure to pass to all plugin functions.
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:516
struct returned by the initialization function of the plugin
static char * plugin
Solver plugin name as string.
Handle for a plugin.
Definition: block.c:37
struct GNUNET_PQ_Context * dbh
Native Postgres database handle.
#define GNUNET_free(ptr)
Wrapper around free.
Here is the call graph for this function: