GNUnet  0.10.x
Data Structures | Macros | Functions
plugin_datacache_sqlite.c File Reference

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

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_datacache_plugin.h"
#include "gnunet_sq_lib.h"
#include <sqlite3.h>
Include dependency graph for plugin_datacache_sqlite.c:

Go to the source code of this file.

Data Structures

struct  Plugin
 Handle for a plugin. More...
 

Macros

#define LOG(kind, ...)   GNUNET_log_from (kind, "datacache-sqlite", __VA_ARGS__)
 
#define LOG_STRERROR_FILE(kind, op, fn)   GNUNET_log_from_strerror_file (kind, "datacache-sqlite", op, fn)
 
#define OVERHEAD   (sizeof(struct GNUNET_HashCode) + 36)
 How much overhead do we assume per entry in the datacache? More...
 
#define LOG_SQLITE(db, level, cmd)   do { LOG (level, _("`%s' failed at %s:%d with error: %s\n"), cmd, __FILE__, __LINE__, sqlite3_errmsg(db)); } while(0)
 Log an error message at log-level level that indicates a failure of the command cmd with the error from the database db. More...
 
#define SQLITE3_EXEC(db, cmd)   do { emsg = NULL; if (SQLITE_OK != sqlite3_exec(db, cmd, NULL, NULL, &emsg)) { LOG (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK, _("`%s' failed at %s:%d with error: %s\n"), "sqlite3_exec", __FILE__, __LINE__, emsg); sqlite3_free(emsg); } } while(0)
 Execute SQL statement. More...
 

Functions

static int sq_prepare (sqlite3 *dbh, const char *zSql, sqlite3_stmt **ppStmt)
 Prepare a SQL statement. More...
 
static ssize_t sqlite_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. More...
 
static unsigned int sqlite_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 sqlite_plugin_del (void *cls)
 Delete the entry with the lowest expiration value from the datacache right now. More...
 
static unsigned int sqlite_plugin_get_random (void *cls, GNUNET_DATACACHE_Iterator iter, void *iter_cls)
 Obtain a random key-value pair from the datacache. More...
 
static unsigned int sqlite_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_sqlite_init (void *cls)
 Entry point for the plugin. More...
 
void * libgnunet_plugin_datacache_sqlite_done (void *cls)
 Exit point from the plugin. More...
 

Detailed Description

sqlite for an implementation of a database backend for the datacache

Author
Christian Grothoff

Definition in file plugin_datacache_sqlite.c.

Macro Definition Documentation

◆ LOG

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

◆ LOG_STRERROR_FILE

#define LOG_STRERROR_FILE (   kind,
  op,
  fn 
)    GNUNET_log_from_strerror_file (kind, "datacache-sqlite", op, fn)

Definition at line 34 of file plugin_datacache_sqlite.c.

Referenced by libgnunet_plugin_datacache_sqlite_done().

◆ OVERHEAD

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

How much overhead do we assume per entry in the datacache?

Definition at line 41 of file plugin_datacache_sqlite.c.

Referenced by sqlite_plugin_del(), and sqlite_plugin_put().

◆ LOG_SQLITE

#define LOG_SQLITE (   db,
  level,
  cmd 
)    do { LOG (level, _("`%s' failed at %s:%d with error: %s\n"), cmd, __FILE__, __LINE__, sqlite3_errmsg(db)); } while(0)

Log an error message at log-level level that indicates a failure of the command cmd with the error from the database db.

Parameters
dbdatabase handle
levellog level
cmdfailed command

Definition at line 118 of file plugin_datacache_sqlite.c.

Referenced by libgnunet_plugin_datacache_sqlite_done(), libgnunet_plugin_datacache_sqlite_init(), sqlite_plugin_del(), sqlite_plugin_get(), sqlite_plugin_get_closest(), and sqlite_plugin_put().

◆ SQLITE3_EXEC

#define SQLITE3_EXEC (   db,
  cmd 
)    do { emsg = NULL; if (SQLITE_OK != sqlite3_exec(db, cmd, NULL, NULL, &emsg)) { LOG (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK, _("`%s' failed at %s:%d with error: %s\n"), "sqlite3_exec", __FILE__, __LINE__, emsg); sqlite3_free(emsg); } } while(0)

Execute SQL statement.

Parameters
dbdatabase handle
cmdSQL command to execute

Definition at line 127 of file plugin_datacache_sqlite.c.

Referenced by libgnunet_plugin_datacache_sqlite_init().

Function Documentation

◆ sq_prepare()

static int sq_prepare ( sqlite3 *  dbh,
const char *  zSql,
sqlite3_stmt **  ppStmt 
)
static

Prepare a SQL statement.

Parameters
dbhdatabase handle
zsqlSQL statement text
[out]ppStmtset to the prepared statement
Returns
0 on success

Definition at line 139 of file plugin_datacache_sqlite.c.

References dummy.

Referenced by libgnunet_plugin_datacache_sqlite_init().

142 { /* OUT: Statement handle */
143  char *dummy;
144 
145  return sqlite3_prepare (dbh,
146  zSql,
147  strlen (zSql),
148  ppStmt,
149  (const char **) &dummy);
150 }
static struct in_addr dummy
Target "dummy" address.
PGconn * dbh
Native Postgres database handle.
Here is the caller graph for this function:

◆ sqlite_plugin_put()

static ssize_t sqlite_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 
)
static

Store an item in the datastore.

Parameters
clsclosure (our struct Plugin)
keykey to store data under
xor_distancehow close is key to our PID?
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_infoarray of peers that have processed the request
Returns
0 if duplicate, -1 on error, number of bytes used otherwise

Definition at line 168 of file plugin_datacache_sqlite.c.

References Plugin::dbh, GNUNET_ERROR_TYPE_BULK, GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_ERROR, GNUNET_h2s(), GNUNET_OK, GNUNET_SQ_bind(), GNUNET_SQ_query_param_absolute_time(), GNUNET_SQ_query_param_auto_from_type, GNUNET_SQ_query_param_end, GNUNET_SQ_query_param_fixed_size(), GNUNET_SQ_query_param_uint32(), GNUNET_SQ_reset(), GNUNET_STRINGS_relative_time_to_string(), GNUNET_TIME_absolute_get_remaining(), GNUNET_YES, Plugin::insert_stmt, LOG, LOG_SQLITE, Plugin::num_items, OVERHEAD, plugin, and type.

Referenced by libgnunet_plugin_datacache_sqlite_init().

177 {
178  struct Plugin *plugin = cls;
179  uint32_t type32 = type;
180  struct GNUNET_SQ_QueryParam params[] = {
182  GNUNET_SQ_query_param_absolute_time (&discard_time),
184  GNUNET_SQ_query_param_uint32 (&xor_distance),
187  path_info_len * sizeof (struct GNUNET_PeerIdentity)),
189  };
190 
192  "Processing PUT of %u bytes with key `%s' and expiration %s\n",
193  (unsigned int) size,
194  GNUNET_h2s (key),
196  GNUNET_YES));
197  if (GNUNET_OK !=
198  GNUNET_SQ_bind (plugin->insert_stmt,
199  params))
200  {
201  LOG_SQLITE (plugin->dbh,
203  "sqlite3_bind_xxx");
204  GNUNET_SQ_reset (plugin->dbh,
205  plugin->insert_stmt);
206  return -1;
207  }
208  if (SQLITE_DONE !=
209  sqlite3_step (plugin->insert_stmt))
210  {
211  LOG_SQLITE (plugin->dbh,
213  "sqlite3_step");
214  GNUNET_SQ_reset (plugin->dbh,
215  plugin->insert_stmt);
216  return -1;
217  }
218  plugin->num_items++;
219  GNUNET_SQ_reset (plugin->dbh,
220  plugin->insert_stmt);
221  return size + OVERHEAD;
222 }
#define LOG(kind,...)
#define GNUNET_SQ_query_param_auto_from_type(x)
Generate fixed-size query parameter with size determined by variable type.
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:78
const char * GNUNET_h2s(const struct GNUNET_HashCode *hc)
Convert a hash value to a string (for printing debug messages).
#define LOG_SQLITE(db, level, cmd)
Log an error message at log-level level that indicates a failure of the command cmd with the error fr...
struct GNUNET_SQ_QueryParam GNUNET_SQ_query_param_uint32(const uint32_t *x)
Generate query parameter for an uint32_t in host byte order.
static struct GNUNET_ATS_SolverFunctions * plugin
Our solver.
sqlite3_stmt * insert_stmt
Prepared statement for sqlite_plugin_put.
const char * GNUNET_STRINGS_relative_time_to_string(struct GNUNET_TIME_Relative delta, int do_round)
Give relative time in human-readable fancy format.
Definition: strings.c:727
#define OVERHEAD
How much overhead do we assume per entry in the datacache?
struct GNUNET_SQ_QueryParam GNUNET_SQ_query_param_absolute_time(const struct GNUNET_TIME_Absolute *x)
Generate query parameter for an absolute time value.
int GNUNET_SQ_bind(sqlite3_stmt *stmt, const struct GNUNET_SQ_QueryParam *params)
Execute binding operations for a prepared statement.
Definition: sq.c:37
static unsigned int size
Size of the "table".
Definition: peer.c:67
Description of a DB query parameter.
Definition: gnunet_sq_lib.h:54
The identity of the host (wraps the signing key of the peer).
void GNUNET_SQ_reset(sqlite3 *dbh, sqlite3_stmt *stmt)
Reset stmt and log error.
Definition: sq.c:132
Handle for a plugin.
Definition: block.c:37
PGconn * dbh
Native Postgres database handle.
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
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model
struct GNUNET_SQ_QueryParam GNUNET_SQ_query_param_fixed_size(const void *ptr, size_t ptr_size)
Generate query parameter for a buffer ptr of ptr_size bytes.
#define GNUNET_YES
Definition: gnunet_common.h:80
unsigned int num_items
Number of key-value pairs in the database.
#define GNUNET_SQ_query_param_end
End of query parameter specification.
Definition: gnunet_sq_lib.h:87
uint32_t data
The data value.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ sqlite_plugin_get()

static unsigned int sqlite_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)
key
typeentries of which type are relevant?
itermaybe NULL (to just count)
iter_clsclosure for iter
Returns
the number of results found

Definition at line 237 of file plugin_datacache_sqlite.c.

References Plugin::dbh, Plugin::get_count_stmt, Plugin::get_stmt, GNUNET_break, GNUNET_CRYPTO_QUALITY_WEAK, GNUNET_CRYPTO_random_u32(), GNUNET_ERROR_TYPE_BULK, GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_ERROR, GNUNET_h2s(), GNUNET_OK, GNUNET_SQ_bind(), GNUNET_SQ_cleanup_result(), GNUNET_SQ_extract_result(), GNUNET_SQ_query_param_absolute_time(), GNUNET_SQ_query_param_auto_from_type, GNUNET_SQ_query_param_end, GNUNET_SQ_query_param_uint32(), GNUNET_SQ_reset(), GNUNET_SQ_result_spec_absolute_time(), GNUNET_SQ_result_spec_end, GNUNET_SQ_result_spec_variable_size(), GNUNET_TIME_absolute_get(), LOG, LOG_SQLITE, plugin, Plugin::size, and type.

Referenced by libgnunet_plugin_datacache_sqlite_init().

242 {
243  struct Plugin *plugin = cls;
244  uint32_t type32 = type;
245  struct GNUNET_TIME_Absolute now;
246  struct GNUNET_TIME_Absolute exp;
247  size_t size;
248  void *dat;
249  unsigned int cnt;
250  uint32_t off;
251  unsigned int total;
252  size_t psize;
253  struct GNUNET_PeerIdentity *path;
254  struct GNUNET_SQ_QueryParam params_count[] = {
259  };
260  struct GNUNET_SQ_QueryParam params_select[] = {
266  };
267  struct GNUNET_SQ_ResultSpec rs[] = {
269  &size),
271  GNUNET_SQ_result_spec_variable_size ((void **) &path,
272  &psize),
274  };
275 
276  now = GNUNET_TIME_absolute_get ();
278  "Processing GET for key `%s'\n",
279  GNUNET_h2s (key));
280 
281  if (GNUNET_OK !=
283  params_count))
284  {
285  LOG_SQLITE (plugin->dbh,
287  "sqlite3_bind_xxx");
288  GNUNET_SQ_reset (plugin->dbh,
289  plugin->get_count_stmt);
290  return 0;
291  }
292  if (SQLITE_ROW !=
293  sqlite3_step (plugin->get_count_stmt))
294  {
296  "sqlite_step");
297  GNUNET_SQ_reset (plugin->dbh,
298  plugin->get_count_stmt);
300  "No content found when processing GET for key `%s'\n",
301  GNUNET_h2s (key));
302  return 0;
303  }
304  total = sqlite3_column_int (plugin->get_count_stmt,
305  0);
306  GNUNET_SQ_reset (plugin->dbh,
307  plugin->get_count_stmt);
308  if ( (0 == total) ||
309  (NULL == iter) )
310  {
311  if (0 == total)
313  "No content found when processing GET for key `%s'\n",
314  GNUNET_h2s (key));
315  return total;
316  }
317 
318  cnt = 0;
320  total);
321  while (cnt < total)
322  {
323  off = (off + 1) % total;
324  if (GNUNET_OK !=
325  GNUNET_SQ_bind (plugin->get_stmt,
326  params_select))
327  {
328  LOG_SQLITE (plugin->dbh,
330  "sqlite3_bind_xxx");
331  GNUNET_SQ_reset (plugin->dbh,
332  plugin->get_stmt);
333  return cnt;
334  }
335  if (SQLITE_ROW !=
336  sqlite3_step (plugin->get_stmt))
337  break;
338  if (GNUNET_OK !=
340  rs))
341  {
342  GNUNET_break (0);
343  GNUNET_SQ_reset (plugin->dbh,
344  plugin->get_stmt);
345  break;
346  }
347  if (0 != psize % sizeof (struct GNUNET_PeerIdentity))
348  {
349  GNUNET_break (0);
350  psize = 0;
351  path = NULL;
352  }
353  psize /= sizeof (struct GNUNET_PeerIdentity);
354  cnt++;
356  "Found %u-byte result when processing GET for key `%s'\n",
357  (unsigned int) size,
358  GNUNET_h2s (key));
359  if (GNUNET_OK != iter (iter_cls,
360  key,
361  size,
362  dat,
363  type,
364  exp,
365  psize,
366  path))
367  {
369  GNUNET_SQ_reset (plugin->dbh,
370  plugin->get_stmt);
371  break;
372  }
374  GNUNET_SQ_reset (plugin->dbh,
375  plugin->get_stmt);
376  }
377  GNUNET_SQ_reset (plugin->dbh,
378  plugin->get_stmt);
379  return cnt;
380 }
Description of a DB result cell.
sqlite3_stmt * get_stmt
Prepared statement for sqlite_plugin_get.
#define LOG(kind,...)
uint32_t GNUNET_CRYPTO_random_u32(enum GNUNET_CRYPTO_Quality mode, uint32_t i)
Produce a random value.
#define GNUNET_SQ_query_param_auto_from_type(x)
Generate fixed-size query parameter with size determined by variable type.
#define GNUNET_SQ_result_spec_end
End of result parameter specification.
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:78
const char * GNUNET_h2s(const struct GNUNET_HashCode *hc)
Convert a hash value to a string (for printing debug messages).
#define LOG_SQLITE(db, level, cmd)
Log an error message at log-level level that indicates a failure of the command cmd with the error fr...
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
struct GNUNET_SQ_ResultSpec GNUNET_SQ_result_spec_absolute_time(struct GNUNET_TIME_Absolute *at)
Absolute time expected.
int GNUNET_SQ_extract_result(sqlite3_stmt *result, struct GNUNET_SQ_ResultSpec *rs)
Extract results from a query result according to the given specification.
Definition: sq.c:82
struct GNUNET_SQ_QueryParam GNUNET_SQ_query_param_uint32(const uint32_t *x)
Generate query parameter for an uint32_t in host byte order.
static struct GNUNET_ATS_SolverFunctions * plugin
Our solver.
void GNUNET_SQ_cleanup_result(struct GNUNET_SQ_ResultSpec *rs)
Free all memory that was allocated in rs during GNUNET_SQ_extract_result().
Definition: sq.c:117
struct GNUNET_SQ_ResultSpec GNUNET_SQ_result_spec_variable_size(void **dst, size_t *sptr)
Variable-size result expected.
struct GNUNET_SQ_QueryParam GNUNET_SQ_query_param_absolute_time(const struct GNUNET_TIME_Absolute *x)
Generate query parameter for an absolute time value.
int GNUNET_SQ_bind(sqlite3_stmt *stmt, const struct GNUNET_SQ_QueryParam *params)
Execute binding operations for a prepared statement.
Definition: sq.c:37
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get(void)
Get the current time.
Definition: time.c:118
static unsigned int size
Size of the "table".
Definition: peer.c:67
Description of a DB query parameter.
Definition: gnunet_sq_lib.h:54
The identity of the host (wraps the signing key of the peer).
void GNUNET_SQ_reset(sqlite3 *dbh, sqlite3_stmt *stmt)
Reset stmt and log error.
Definition: sq.c:132
Handle for a plugin.
Definition: block.c:37
PGconn * dbh
Native Postgres database handle.
sqlite3_stmt * get_count_stmt
Prepared statement for sqlite_plugin_get.
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model
Time for absolute times used by GNUnet, in microseconds.
#define GNUNET_SQ_query_param_end
End of query parameter specification.
Definition: gnunet_sq_lib.h:87
No good quality of the operation is needed (i.e., random numbers can be pseudo-random).
Here is the call graph for this function:
Here is the caller graph for this function:

◆ sqlite_plugin_del()

static int sqlite_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 391 of file plugin_datacache_sqlite.c.

References GNUNET_DATACACHE_PluginEnvironment::cls, data, Plugin::dbh, Plugin::del_expired_stmt, Plugin::del_select_stmt, Plugin::del_stmt, GNUNET_DATACACHE_PluginEnvironment::delete_notify, Plugin::env, GNUNET_break, GNUNET_ERROR_TYPE_BULK, GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_ERROR, GNUNET_OK, GNUNET_SQ_bind(), GNUNET_SQ_cleanup_result(), GNUNET_SQ_extract_result(), GNUNET_SQ_query_param_absolute_time(), GNUNET_SQ_query_param_end, GNUNET_SQ_query_param_uint64(), GNUNET_SQ_reset(), GNUNET_SQ_result_spec_auto_from_type, GNUNET_SQ_result_spec_end, GNUNET_SQ_result_spec_uint64(), GNUNET_SQ_result_spec_variable_size(), GNUNET_SYSERR, GNUNET_TIME_absolute_get(), LOG, LOG_SQLITE, Plugin::num_items, OVERHEAD, and plugin.

Referenced by libgnunet_plugin_datacache_sqlite_init().

392 {
393  struct Plugin *plugin = cls;
394  uint64_t rowid;
395  void *data;
396  size_t dsize;
397  struct GNUNET_HashCode hc;
398  struct GNUNET_TIME_Absolute now;
399  struct GNUNET_SQ_ResultSpec rs[] = {
402  GNUNET_SQ_result_spec_variable_size ((void **) &data,
403  &dsize),
405  };
406  struct GNUNET_SQ_QueryParam params[] = {
409  };
410  struct GNUNET_SQ_QueryParam time_params[] = {
413  };
414 
416  "Processing DEL\n");
417  now = GNUNET_TIME_absolute_get ();
418  if (GNUNET_OK !=
420  time_params))
421  {
422  LOG_SQLITE (plugin->dbh,
424  "sqlite3_bind");
425  GNUNET_SQ_reset (plugin->dbh,
426  plugin->del_expired_stmt);
427  return GNUNET_SYSERR;
428  }
429  if ( (SQLITE_ROW !=
430  sqlite3_step (plugin->del_expired_stmt)) ||
431  (GNUNET_OK !=
433  rs)) )
434  {
435  GNUNET_SQ_reset (plugin->dbh,
436  plugin->del_expired_stmt);
437  if (SQLITE_ROW !=
438  sqlite3_step (plugin->del_select_stmt))
439  {
440  LOG_SQLITE (plugin->dbh,
442  "sqlite3_step");
443  GNUNET_SQ_reset (plugin->dbh,
444  plugin->del_select_stmt);
445  return GNUNET_SYSERR;
446  }
447  if (GNUNET_OK !=
449  rs))
450  {
451  GNUNET_SQ_reset (plugin->dbh,
452  plugin->del_select_stmt);
453  GNUNET_break (0);
454  return GNUNET_SYSERR;
455  }
456  }
458  GNUNET_SQ_reset (plugin->dbh,
459  plugin->del_select_stmt);
460  if (GNUNET_OK !=
461  GNUNET_SQ_bind (plugin->del_stmt,
462  params))
463  {
464  LOG_SQLITE (plugin->dbh,
466  "sqlite3_bind");
467  GNUNET_SQ_reset (plugin->dbh,
468  plugin->del_stmt);
469  return GNUNET_SYSERR;
470  }
471  if (SQLITE_DONE !=
472  sqlite3_step (plugin->del_stmt))
473  {
474  LOG_SQLITE (plugin->dbh,
476  "sqlite3_step");
477  GNUNET_SQ_reset (plugin->dbh,
478  plugin->del_stmt);
479  return GNUNET_SYSERR;
480  }
481  plugin->num_items--;
482  plugin->env->delete_notify (plugin->env->cls,
483  &hc,
484  dsize + OVERHEAD);
485  GNUNET_SQ_reset (plugin->dbh,
486  plugin->del_stmt);
487  return GNUNET_OK;
488 }
sqlite3_stmt * del_expired_stmt
Prepared statement for sqlite_plugin_del.
Description of a DB result cell.
#define LOG(kind,...)
#define GNUNET_SQ_result_spec_end
End of result parameter specification.
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:78
#define LOG_SQLITE(db, level, cmd)
Log an error message at log-level level that indicates a failure of the command cmd with the error fr...
#define GNUNET_SQ_result_spec_auto_from_type(dst)
We expect a fixed-size result, with size determined by the type of * dst
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
GNUNET_DATACACHE_DeleteNotifyCallback delete_notify
Function to call whenever the plugin needs to discard content that it was asked to store...
int GNUNET_SQ_extract_result(sqlite3_stmt *result, struct GNUNET_SQ_ResultSpec *rs)
Extract results from a query result according to the given specification.
Definition: sq.c:82
static struct GNUNET_ATS_SolverFunctions * plugin
Our solver.
void GNUNET_SQ_cleanup_result(struct GNUNET_SQ_ResultSpec *rs)
Free all memory that was allocated in rs during GNUNET_SQ_extract_result().
Definition: sq.c:117
struct GNUNET_DATACACHE_PluginEnvironment * env
Our execution environment.
sqlite3_stmt * del_select_stmt
Prepared statement for sqlite_plugin_del.
struct GNUNET_SQ_ResultSpec GNUNET_SQ_result_spec_variable_size(void **dst, size_t *sptr)
Variable-size result expected.
#define OVERHEAD
How much overhead do we assume per entry in the datacache?
struct GNUNET_SQ_QueryParam GNUNET_SQ_query_param_absolute_time(const struct GNUNET_TIME_Absolute *x)
Generate query parameter for an absolute time value.
A 512-bit hashcode.
int GNUNET_SQ_bind(sqlite3_stmt *stmt, const struct GNUNET_SQ_QueryParam *params)
Execute binding operations for a prepared statement.
Definition: sq.c:37
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get(void)
Get the current time.
Definition: time.c:118
sqlite3_stmt * del_stmt
Prepared statement for sqlite_plugin_del.
#define GNUNET_SYSERR
Definition: gnunet_common.h:79
Description of a DB query parameter.
Definition: gnunet_sq_lib.h:54
struct GNUNET_SQ_ResultSpec GNUNET_SQ_result_spec_uint64(uint64_t *u64)
uint64_t expected.
void GNUNET_SQ_reset(sqlite3 *dbh, sqlite3_stmt *stmt)
Reset stmt and log error.
Definition: sq.c:132
struct GNUNET_SQ_QueryParam GNUNET_SQ_query_param_uint64(const uint64_t *x)
Generate query parameter for an uint16_t in host byte order.
Handle for a plugin.
Definition: block.c:37
PGconn * dbh
Native Postgres database handle.
void * cls
Closure to use for callbacks.
Time for absolute times used by GNUnet, in microseconds.
unsigned int num_items
Number of key-value pairs in the database.
#define GNUNET_SQ_query_param_end
End of query parameter specification.
Definition: gnunet_sq_lib.h:87
uint32_t data
The data value.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ sqlite_plugin_get_random()

static unsigned int sqlite_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 500 of file plugin_datacache_sqlite.c.

References Plugin::dbh, Plugin::get_random_stmt, GNUNET_break, GNUNET_CRYPTO_QUALITY_NONCE, GNUNET_CRYPTO_random_u32(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_h2s(), GNUNET_OK, GNUNET_SQ_bind(), GNUNET_SQ_cleanup_result(), GNUNET_SQ_extract_result(), GNUNET_SQ_query_param_end, GNUNET_SQ_query_param_uint32(), GNUNET_SQ_reset(), GNUNET_SQ_result_spec_absolute_time(), GNUNET_SQ_result_spec_auto_from_type, GNUNET_SQ_result_spec_end, GNUNET_SQ_result_spec_uint32(), GNUNET_SQ_result_spec_variable_size(), LOG, Plugin::num_items, plugin, Plugin::size, and type.

Referenced by libgnunet_plugin_datacache_sqlite_init().

503 {
504  struct Plugin *plugin = cls;
505  struct GNUNET_TIME_Absolute exp;
506  size_t size;
507  void *dat;
508  uint32_t off;
509  size_t psize;
510  uint32_t type;
511  struct GNUNET_PeerIdentity *path;
512  struct GNUNET_HashCode key;
513  struct GNUNET_SQ_QueryParam params[] = {
516  };
517  struct GNUNET_SQ_ResultSpec rs[] = {
519  &size),
521  GNUNET_SQ_result_spec_variable_size ((void **) &path,
522  &psize),
526  };
527 
528  if (0 == plugin->num_items)
529  return 0;
530  if (NULL == iter)
531  return 1;
533  plugin->num_items);
534  if (GNUNET_OK !=
536  params))
537  {
538  return 0;
539  }
540  if (SQLITE_ROW !=
541  sqlite3_step (plugin->get_random_stmt))
542  {
543  GNUNET_break (0);
544  GNUNET_SQ_reset (plugin->dbh,
545  plugin->get_random_stmt);
546  return 0;
547  }
548  if (GNUNET_OK !=
550  rs))
551  {
552  GNUNET_break (0);
553  GNUNET_SQ_reset (plugin->dbh,
554  plugin->get_random_stmt);
555  return 0;
556  }
557  if (0 != psize % sizeof (struct GNUNET_PeerIdentity))
558  {
559  GNUNET_break (0);
560  psize = 0;
561  path = NULL;
562  }
563  psize /= sizeof (struct GNUNET_PeerIdentity);
565  "Found %u-byte result with key %s when processing GET-RANDOM\n",
566  (unsigned int) size,
567  GNUNET_h2s (&key));
568  (void) iter (iter_cls,
569  &key,
570  size,
571  dat,
572  (enum GNUNET_BLOCK_Type) type,
573  exp,
574  psize,
575  path);
577  GNUNET_SQ_reset (plugin->dbh,
578  plugin->get_random_stmt);
579  return 1;
580 }
Description of a DB result cell.
struct GNUNET_SQ_ResultSpec GNUNET_SQ_result_spec_uint32(uint32_t *u32)
uint32_t expected.
GNUNET_BLOCK_Type
Blocks in the datastore and the datacache must have a unique type.
#define LOG(kind,...)
uint32_t GNUNET_CRYPTO_random_u32(enum GNUNET_CRYPTO_Quality mode, uint32_t i)
Produce a random value.
#define GNUNET_SQ_result_spec_end
End of result parameter specification.
const char * GNUNET_h2s(const struct GNUNET_HashCode *hc)
Convert a hash value to a string (for printing debug messages).
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:78
#define GNUNET_SQ_result_spec_auto_from_type(dst)
We expect a fixed-size result, with size determined by the type of * dst
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
struct GNUNET_SQ_ResultSpec GNUNET_SQ_result_spec_absolute_time(struct GNUNET_TIME_Absolute *at)
Absolute time expected.
int GNUNET_SQ_extract_result(sqlite3_stmt *result, struct GNUNET_SQ_ResultSpec *rs)
Extract results from a query result according to the given specification.
Definition: sq.c:82
struct GNUNET_SQ_QueryParam GNUNET_SQ_query_param_uint32(const uint32_t *x)
Generate query parameter for an uint32_t in host byte order.
static struct GNUNET_ATS_SolverFunctions * plugin
Our solver.
void GNUNET_SQ_cleanup_result(struct GNUNET_SQ_ResultSpec *rs)
Free all memory that was allocated in rs during GNUNET_SQ_extract_result().
Definition: sq.c:117
sqlite3_stmt * get_random_stmt
Prepared statement for sqlite_plugin_get_random.
Randomness for IVs etc.
struct GNUNET_SQ_ResultSpec GNUNET_SQ_result_spec_variable_size(void **dst, size_t *sptr)
Variable-size result expected.
A 512-bit hashcode.
int GNUNET_SQ_bind(sqlite3_stmt *stmt, const struct GNUNET_SQ_QueryParam *params)
Execute binding operations for a prepared statement.
Definition: sq.c:37
struct GNUNET_HashCode key
The key used in the DHT.
static unsigned int size
Size of the "table".
Definition: peer.c:67
Description of a DB query parameter.
Definition: gnunet_sq_lib.h:54
The identity of the host (wraps the signing key of the peer).
void GNUNET_SQ_reset(sqlite3 *dbh, sqlite3_stmt *stmt)
Reset stmt and log error.
Definition: sq.c:132
Handle for a plugin.
Definition: block.c:37
PGconn * dbh
Native Postgres database handle.
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model
Time for absolute times used by GNUnet, in microseconds.
unsigned int num_items
Number of key-value pairs in the database.
#define GNUNET_SQ_query_param_end
End of query parameter specification.
Definition: gnunet_sq_lib.h:87
Here is the call graph for this function:
Here is the caller graph for this function:

◆ sqlite_plugin_get_closest()

static unsigned int sqlite_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 597 of file plugin_datacache_sqlite.c.

References Plugin::dbh, Plugin::get_closest_stmt, GNUNET_break, GNUNET_ERROR_TYPE_BULK, GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_ERROR, GNUNET_h2s(), GNUNET_OK, GNUNET_SQ_bind(), GNUNET_SQ_cleanup_result(), GNUNET_SQ_extract_result(), GNUNET_SQ_query_param_absolute_time(), GNUNET_SQ_query_param_auto_from_type, GNUNET_SQ_query_param_end, GNUNET_SQ_query_param_uint32(), GNUNET_SQ_reset(), GNUNET_SQ_result_spec_absolute_time(), GNUNET_SQ_result_spec_auto_from_type, GNUNET_SQ_result_spec_end, GNUNET_SQ_result_spec_uint32(), GNUNET_SQ_result_spec_variable_size(), GNUNET_TIME_absolute_get(), LOG, LOG_SQLITE, plugin, Plugin::size, and type.

Referenced by libgnunet_plugin_datacache_sqlite_init().

602 {
603  struct Plugin *plugin = cls;
604  uint32_t num_results32 = num_results;
605  struct GNUNET_TIME_Absolute now;
606  struct GNUNET_TIME_Absolute exp;
607  size_t size;
608  void *dat;
609  unsigned int cnt;
610  size_t psize;
611  uint32_t type;
612  struct GNUNET_HashCode hc;
613  struct GNUNET_PeerIdentity *path;
614  struct GNUNET_SQ_QueryParam params[] = {
617  GNUNET_SQ_query_param_uint32 (&num_results32),
619  };
620  struct GNUNET_SQ_ResultSpec rs[] = {
622  &size),
624  GNUNET_SQ_result_spec_variable_size ((void **) &path,
625  &psize),
629  };
630 
631  now = GNUNET_TIME_absolute_get ();
633  "Processing GET_CLOSEST for key `%s'\n",
634  GNUNET_h2s (key));
635  if (GNUNET_OK !=
637  params))
638  {
639  LOG_SQLITE (plugin->dbh,
641  "sqlite3_bind_xxx");
642  GNUNET_SQ_reset (plugin->dbh,
643  plugin->get_closest_stmt);
644  return 0;
645  }
646  cnt = 0;
647  while (SQLITE_ROW ==
648  sqlite3_step (plugin->get_closest_stmt))
649  {
650  if (GNUNET_OK !=
652  rs))
653  {
654  GNUNET_break (0);
655  break;
656  }
657  if (0 != psize % sizeof (struct GNUNET_PeerIdentity))
658  {
659  GNUNET_break (0);
660  psize = 0;
661  path = NULL;
662  }
663  psize /= sizeof (struct GNUNET_PeerIdentity);
664  cnt++;
666  "Found %u-byte result at %s when processing GET_CLOSE\n",
667  (unsigned int) size,
668  GNUNET_h2s (&hc));
669  if (GNUNET_OK != iter (iter_cls,
670  &hc,
671  size,
672  dat,
673  type,
674  exp,
675  psize,
676  path))
677  {
679  break;
680  }
682  }
683  GNUNET_SQ_reset (plugin->dbh,
684  plugin->get_closest_stmt);
685  return cnt;
686 }
Description of a DB result cell.
struct GNUNET_SQ_ResultSpec GNUNET_SQ_result_spec_uint32(uint32_t *u32)
uint32_t expected.
#define LOG(kind,...)
#define GNUNET_SQ_query_param_auto_from_type(x)
Generate fixed-size query parameter with size determined by variable type.
#define GNUNET_SQ_result_spec_end
End of result parameter specification.
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:78
const char * GNUNET_h2s(const struct GNUNET_HashCode *hc)
Convert a hash value to a string (for printing debug messages).
#define LOG_SQLITE(db, level, cmd)
Log an error message at log-level level that indicates a failure of the command cmd with the error fr...
#define GNUNET_SQ_result_spec_auto_from_type(dst)
We expect a fixed-size result, with size determined by the type of * dst
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
struct GNUNET_SQ_ResultSpec GNUNET_SQ_result_spec_absolute_time(struct GNUNET_TIME_Absolute *at)
Absolute time expected.
int GNUNET_SQ_extract_result(sqlite3_stmt *result, struct GNUNET_SQ_ResultSpec *rs)
Extract results from a query result according to the given specification.
Definition: sq.c:82
struct GNUNET_SQ_QueryParam GNUNET_SQ_query_param_uint32(const uint32_t *x)
Generate query parameter for an uint32_t in host byte order.
static struct GNUNET_ATS_SolverFunctions * plugin
Our solver.
void GNUNET_SQ_cleanup_result(struct GNUNET_SQ_ResultSpec *rs)
Free all memory that was allocated in rs during GNUNET_SQ_extract_result().
Definition: sq.c:117
struct GNUNET_SQ_ResultSpec GNUNET_SQ_result_spec_variable_size(void **dst, size_t *sptr)
Variable-size result expected.
sqlite3_stmt * get_closest_stmt
Prepared statement for sqlite_plugin_get_closest.
struct GNUNET_SQ_QueryParam GNUNET_SQ_query_param_absolute_time(const struct GNUNET_TIME_Absolute *x)
Generate query parameter for an absolute time value.
A 512-bit hashcode.
int GNUNET_SQ_bind(sqlite3_stmt *stmt, const struct GNUNET_SQ_QueryParam *params)
Execute binding operations for a prepared statement.
Definition: sq.c:37
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get(void)
Get the current time.
Definition: time.c:118
static unsigned int size
Size of the "table".
Definition: peer.c:67
Description of a DB query parameter.
Definition: gnunet_sq_lib.h:54
The identity of the host (wraps the signing key of the peer).
void GNUNET_SQ_reset(sqlite3 *dbh, sqlite3_stmt *stmt)
Reset stmt and log error.
Definition: sq.c:132
Handle for a plugin.
Definition: block.c:37
PGconn * dbh
Native Postgres database handle.
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model
Time for absolute times used by GNUnet, in microseconds.
#define GNUNET_SQ_query_param_end
End of query parameter specification.
Definition: gnunet_sq_lib.h:87
Here is the call graph for this function:
Here is the caller graph for this function:

◆ libgnunet_plugin_datacache_sqlite_init()

void* libgnunet_plugin_datacache_sqlite_init ( void *  cls)

Entry point for the plugin.

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

Definition at line 696 of file plugin_datacache_sqlite.c.

References Plugin::api, GNUNET_DATACACHE_PluginEnvironment::cfg, GNUNET_DATACACHE_PluginEnvironment::cls, GNUNET_DATACACHE_PluginFunctions::cls, Plugin::dbh, GNUNET_DATACACHE_PluginFunctions::del, Plugin::del_expired_stmt, Plugin::del_select_stmt, Plugin::del_stmt, Plugin::env, Plugin::fn, GNUNET_DATACACHE_PluginFunctions::get, GNUNET_DATACACHE_PluginFunctions::get_closest, Plugin::get_closest_stmt, Plugin::get_count_stmt, GNUNET_DATACACHE_PluginFunctions::get_random, Plugin::get_random_stmt, Plugin::get_stmt, GNUNET_break, GNUNET_CONFIGURATION_get_value_yesno(), GNUNET_DISK_mktemp(), GNUNET_ERROR_TYPE_BULK, GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_INFO, GNUNET_free, GNUNET_new, GNUNET_strdup, GNUNET_YES, Plugin::insert_stmt, LOG, LOG_SQLITE, plugin, GNUNET_DATACACHE_PluginFunctions::put, sq_prepare(), SQLITE3_EXEC, sqlite_plugin_del(), sqlite_plugin_get(), sqlite_plugin_get_closest(), sqlite_plugin_get_random(), and sqlite_plugin_put().

697 {
700  struct Plugin *plugin;
701  char *fn;
702  char *fn_utf8;
703  sqlite3 *dbh;
704  char *emsg;
705 
706  if (GNUNET_YES ==
708  "datacache-sqlite",
709  "IN_MEMORY"))
710  {
711  if (SQLITE_OK != sqlite3_open (":memory:", &dbh))
712  return NULL;
713  fn_utf8 = NULL;
714  }
715  else
716  {
717  fn = GNUNET_DISK_mktemp ("gnunet-datacache");
718  if (fn == NULL)
719  {
720  GNUNET_break (0);
721  return NULL;
722  }
723  /* fn should be UTF-8-encoded. If it isn't, it's a bug. */
724  fn_utf8 = GNUNET_strdup (fn);
725  if (SQLITE_OK != sqlite3_open (fn_utf8, &dbh))
726  {
727  GNUNET_free (fn);
728  GNUNET_free (fn_utf8);
729  return NULL;
730  }
731  GNUNET_free (fn);
732  }
733 
734  SQLITE3_EXEC (dbh, "PRAGMA temp_store=MEMORY");
735  SQLITE3_EXEC (dbh, "PRAGMA locking_mode=EXCLUSIVE");
736  SQLITE3_EXEC (dbh, "PRAGMA journal_mode=OFF");
737  SQLITE3_EXEC (dbh, "PRAGMA synchronous=OFF");
738  SQLITE3_EXEC (dbh, "PRAGMA page_size=4092");
739  if (GNUNET_YES ==
741  "datacache-sqlite",
742  "IN_MEMORY"))
743  SQLITE3_EXEC (dbh, "PRAGMA sqlite_temp_store=3");
744 
745  SQLITE3_EXEC (dbh,
746  "CREATE TABLE ds091 ("
747  " type INTEGER NOT NULL DEFAULT 0,"
748  " expire INTEGER NOT NULL,"
749  " key BLOB NOT NULL DEFAULT '',"
750  " prox INTEGER NOT NULL,"
751  " value BLOB NOT NULL,"
752  " path BLOB DEFAULT '')");
753  SQLITE3_EXEC (dbh, "CREATE INDEX idx_hashidx ON ds091 (key,type,expire)");
754  SQLITE3_EXEC (dbh, "CREATE INDEX idx_prox_expire ON ds091 (prox,expire)");
755  SQLITE3_EXEC (dbh, "CREATE INDEX idx_expire_only ON ds091 (expire)");
756  plugin = GNUNET_new (struct Plugin);
757  plugin->env = env;
758  plugin->dbh = dbh;
759  plugin->fn = fn_utf8;
760 
761  if ( (SQLITE_OK !=
762  sq_prepare (plugin->dbh,
763  "INSERT INTO ds091 (type, expire, key, prox, value, path) "
764  "VALUES (?, ?, ?, ?, ?, ?)",
765  &plugin->insert_stmt)) ||
766  (SQLITE_OK !=
767  sq_prepare (plugin->dbh,
768  "SELECT count(*) FROM ds091 "
769  "WHERE key=? AND type=? AND expire >= ?",
770  &plugin->get_count_stmt)) ||
771  (SQLITE_OK !=
772  sq_prepare (plugin->dbh,
773  "SELECT value,expire,path FROM ds091"
774  " WHERE key=? AND type=? AND expire >= ? LIMIT 1 OFFSET ?",
775  &plugin->get_stmt)) ||
776  (SQLITE_OK !=
777  sq_prepare (plugin->dbh,
778  "SELECT _ROWID_,key,value FROM ds091"
779  " WHERE expire < ?"
780  " ORDER BY expire ASC LIMIT 1",
781  &plugin->del_expired_stmt)) ||
782  (SQLITE_OK !=
783  sq_prepare (plugin->dbh,
784  "SELECT _ROWID_,key,value FROM ds091"
785  " ORDER BY prox ASC, expire ASC LIMIT 1",
786  &plugin->del_select_stmt)) ||
787  (SQLITE_OK !=
788  sq_prepare (plugin->dbh,
789  "DELETE FROM ds091 WHERE _ROWID_=?",
790  &plugin->del_stmt)) ||
791  (SQLITE_OK !=
792  sq_prepare (plugin->dbh,
793  "SELECT value,expire,path,key,type FROM ds091 "
794  "ORDER BY key LIMIT 1 OFFSET ?",
795  &plugin->get_random_stmt)) ||
796  (SQLITE_OK !=
797  sq_prepare (plugin->dbh,
798  "SELECT value,expire,path,type,key FROM ds091 "
799  "WHERE key>=? AND expire >= ? ORDER BY KEY ASC LIMIT ?",
800  &plugin->get_closest_stmt))
801  )
802  {
803  LOG_SQLITE (plugin->dbh,
805  "sq_prepare");
806  GNUNET_break (SQLITE_OK ==
807  sqlite3_close (plugin->dbh));
808  GNUNET_free (plugin);
809  return NULL;
810  }
811 
813  api->cls = plugin;
814  api->get = &sqlite_plugin_get;
815  api->put = &sqlite_plugin_put;
816  api->del = &sqlite_plugin_del;
820  "Sqlite datacache running\n");
821  return api;
822 }
#define SQLITE3_EXEC(db, cmd)
Execute SQL statement.
void * cls
Closure to pass to all plugin functions.
sqlite3_stmt * del_expired_stmt
Prepared statement for sqlite_plugin_del.
static unsigned int sqlite_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.
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.
sqlite3_stmt * get_stmt
Prepared statement for sqlite_plugin_get.
const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration to use.
#define LOG(kind,...)
static int sqlite_plugin_del(void *cls)
Delete the entry with the lowest expiration value from the datacache right now.
static ssize_t sqlite_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.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
#define LOG_SQLITE(db, level, cmd)
Log an error message at log-level level that indicates a failure of the command cmd with the error fr...
#define GNUNET_strdup(a)
Wrapper around GNUNET_xstrdup_.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
struct GNUNET_BLOCK_PluginFunctions * api
Plugin API.
Definition: block.c:47
static unsigned int sqlite_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.
static struct GNUNET_ATS_SolverFunctions * plugin
Our solver.
sqlite3_stmt * insert_stmt
Prepared statement for sqlite_plugin_put.
char * GNUNET_DISK_mktemp(const char *t)
Create an (empty) temporary file on disk.
Definition: disk.c:593
sqlite3_stmt * get_random_stmt
Prepared statement for sqlite_plugin_get_random.
static char * fn
Filename of the unique file.
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 int sq_prepare(sqlite3 *dbh, const char *zSql, sqlite3_stmt **ppStmt)
Prepare a SQL statement.
static unsigned int sqlite_plugin_get_random(void *cls, GNUNET_DATACACHE_Iterator iter, void *iter_cls)
Obtain a random key-value pair from the datacache.
sqlite3_stmt * del_select_stmt
Prepared statement for sqlite_plugin_del.
struct returned by the initialization function of the plugin
sqlite3_stmt * get_closest_stmt
Prepared statement for sqlite_plugin_get_closest.
sqlite3_stmt * del_stmt
Prepared statement for sqlite_plugin_del.
struct GNUNET_MQ_Envelope * env
Definition: 005.c:1
char * fn
Filename used for the DB.
Handle for a plugin.
Definition: block.c:37
PGconn * dbh
Native Postgres database handle.
sqlite3_stmt * get_count_stmt
Prepared statement for sqlite_plugin_get.
void * cls
Closure to use for callbacks.
#define GNUNET_YES
Definition: gnunet_common.h:80
unsigned int(* get_random)(void *cls, GNUNET_DATACACHE_Iterator iter, void *iter_cls)
Return a random value from the datastore.
int GNUNET_CONFIGURATION_get_value_yesno(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option)
Get a configuration value that should be in a set of "YES" or "NO".
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_sqlite_done()

void* libgnunet_plugin_datacache_sqlite_done ( void *  cls)

Exit point from the plugin.

Parameters
clsclosure (our struct Plugin)
Returns
NULL

Definition at line 832 of file plugin_datacache_sqlite.c.

References _, Plugin::api, GNUNET_DATACACHE_PluginFunctions::cls, Plugin::dbh, Plugin::del_expired_stmt, Plugin::del_select_stmt, Plugin::del_stmt, Plugin::fn, Plugin::get_closest_stmt, Plugin::get_count_stmt, Plugin::get_random_stmt, Plugin::get_stmt, GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_free_non_null, Plugin::insert_stmt, LOG, LOG_SQLITE, LOG_STRERROR_FILE, plugin, result, and UNLINK.

833 {
835  struct Plugin *plugin = api->cls;
836  int result;
837 
838 #if SQLITE_VERSION_NUMBER >= 3007000
839  sqlite3_stmt *stmt;
840 #endif
841 
842 #if !WINDOWS || defined(__CYGWIN__)
843  if ( (NULL != plugin->fn) &&
844  (0 != UNLINK (plugin->fn)) )
846  "unlink",
847  plugin->fn);
848  GNUNET_free_non_null (plugin->fn);
849 #endif
850  sqlite3_finalize (plugin->insert_stmt);
851  sqlite3_finalize (plugin->get_count_stmt);
852  sqlite3_finalize (plugin->get_stmt);
853  sqlite3_finalize (plugin->del_select_stmt);
854  sqlite3_finalize (plugin->del_expired_stmt);
855  sqlite3_finalize (plugin->del_stmt);
856  sqlite3_finalize (plugin->get_random_stmt);
857  sqlite3_finalize (plugin->get_closest_stmt);
858  result = sqlite3_close (plugin->dbh);
859 #if SQLITE_VERSION_NUMBER >= 3007000
860  if (SQLITE_BUSY == result)
861  {
863  _("Tried to close sqlite without finalizing all prepared statements.\n"));
864  stmt = sqlite3_next_stmt (plugin->dbh, NULL);
865  while (NULL != stmt)
866  {
867  result = sqlite3_finalize (stmt);
868  if (result != SQLITE_OK)
870  "Failed to close statement %p: %d\n",
871  stmt,
872  result);
873  stmt = sqlite3_next_stmt (plugin->dbh, NULL);
874  }
875  result = sqlite3_close (plugin->dbh);
876  }
877 #endif
878  if (SQLITE_OK != result)
879  LOG_SQLITE (plugin->dbh,
881  "sqlite3_close");
882 
883 #if WINDOWS && !defined(__CYGWIN__)
884  if ( (NULL != plugin->fn) &&
885  (0 != UNLINK (plugin->fn)) )
887  "unlink",
888  plugin->fn);
889  GNUNET_free_non_null (plugin->fn);
890 #endif
891  GNUNET_free (plugin);
892  GNUNET_free (api);
893  return NULL;
894 }
void * cls
Closure to pass to all plugin functions.
sqlite3_stmt * del_expired_stmt
Prepared statement for sqlite_plugin_del.
sqlite3_stmt * get_stmt
Prepared statement for sqlite_plugin_get.
#define LOG(kind,...)
#define GNUNET_free_non_null(ptr)
Free the memory pointed to by ptr if ptr is not NULL.
#define LOG_SQLITE(db, level, cmd)
Log an error message at log-level level that indicates a failure of the command cmd with the error fr...
#define UNLINK(f)
Definition: plibc.h:666
#define _(String)
GNU gettext support macro.
Definition: platform.h:208
static struct GNUNET_ATS_SolverFunctions * plugin
Our solver.
sqlite3_stmt * insert_stmt
Prepared statement for sqlite_plugin_put.
sqlite3_stmt * get_random_stmt
Prepared statement for sqlite_plugin_get_random.
sqlite3_stmt * del_select_stmt
Prepared statement for sqlite_plugin_del.
struct returned by the initialization function of the plugin
static int result
Global testing status.
sqlite3_stmt * get_closest_stmt
Prepared statement for sqlite_plugin_get_closest.
sqlite3_stmt * del_stmt
Prepared statement for sqlite_plugin_del.
char * fn
Filename used for the DB.
#define LOG_STRERROR_FILE(kind, op, fn)
Handle for a plugin.
Definition: block.c:37
PGconn * dbh
Native Postgres database handle.
sqlite3_stmt * get_count_stmt
Prepared statement for sqlite_plugin_get.
#define GNUNET_free(ptr)
Wrapper around free.