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)
 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)
 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 42 of file plugin_datacache_sqlite.c.

Referenced by sqlite_plugin_del(), and sqlite_plugin_put().

◆ LOG_SQLITE

#define LOG_SQLITE (   db,
  level,
  cmd 
)
Value:
do \
{ \
LOG(level, \
_("`%s' failed at %s:%d with error: %s\n"), \
cmd, \
__FILE__, \
__LINE__, \
sqlite3_errmsg(db)); \
} while (0)
#define _(String)
GNU gettext support macro.
Definition: platform.h:181
static struct GNUNET_FS_DirectoryBuilder * db
Definition: gnunet-search.c:41

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 
)
Value:
do \
{ \
emsg = NULL; \
if (SQLITE_OK != sqlite3_exec(db, cmd, NULL, NULL, &emsg)) \
{ \
_("`%s' failed at %s:%d with error: %s\n"), \
"sqlite3_exec", \
__FILE__, \
__LINE__, \
emsg); \
sqlite3_free(emsg); \
} \
} while (0)
#define _(String)
GNU gettext support macro.
Definition: platform.h:181
static struct GNUNET_FS_DirectoryBuilder * db
Definition: gnunet-search.c:41

Execute SQL statement.

Parameters
dbdatabase handle
cmdSQL command to execute

Definition at line 136 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 162 of file plugin_datacache_sqlite.c.

References dummy.

Referenced by libgnunet_plugin_datacache_sqlite_init().

165 { /* OUT: Statement handle */
166  char *dummy;
167 
168  return sqlite3_prepare(dbh,
169  zSql,
170  strlen(zSql),
171  ppStmt,
172  (const char **)&dummy);
173 }
static struct in_addr dummy
Target "dummy" address of the packet we pretend to respond to.
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 191 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().

200 {
201  struct Plugin *plugin = cls;
202  uint32_t type32 = type;
203  struct GNUNET_SQ_QueryParam params[] =
204  { GNUNET_SQ_query_param_uint32(&type32),
207  GNUNET_SQ_query_param_uint32(&xor_distance),
210  path_info_len *
211  sizeof(struct GNUNET_PeerIdentity)),
213 
215  "Processing PUT of %u bytes with key `%s' and expiration %s\n",
216  (unsigned int)size,
217  GNUNET_h2s(key),
219  discard_time),
220  GNUNET_YES));
221  if (GNUNET_OK != GNUNET_SQ_bind(plugin->insert_stmt, params))
222  {
223  LOG_SQLITE(plugin->dbh,
225  "sqlite3_bind_xxx");
226  GNUNET_SQ_reset(plugin->dbh, plugin->insert_stmt);
227  return -1;
228  }
229  if (SQLITE_DONE != sqlite3_step(plugin->insert_stmt))
230  {
231  LOG_SQLITE(plugin->dbh,
233  "sqlite3_step");
234  GNUNET_SQ_reset(plugin->dbh, plugin->insert_stmt);
235  return -1;
236  }
237  plugin->num_items++;
238  GNUNET_SQ_reset(plugin->dbh, plugin->insert_stmt);
239  return size + OVERHEAD;
240 }
#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:75
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:686
#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:66
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:77
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:85
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 255 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(), Plugin::iter, LOG, LOG_SQLITE, plugin, Plugin::size, and type.

Referenced by libgnunet_plugin_datacache_sqlite_init().

260 {
261  struct Plugin *plugin = cls;
262  uint32_t type32 = type;
263  struct GNUNET_TIME_Absolute now;
264  struct GNUNET_TIME_Absolute exp;
265  size_t size;
266  void *dat;
267  unsigned int cnt;
268  uint32_t off;
269  unsigned int total;
270  size_t psize;
271  struct GNUNET_PeerIdentity *path;
272  struct GNUNET_SQ_QueryParam params_count[] =
277  struct GNUNET_SQ_QueryParam params_select[] =
283  struct GNUNET_SQ_ResultSpec rs[] =
286  GNUNET_SQ_result_spec_variable_size((void **)&path, &psize),
288 
289  now = GNUNET_TIME_absolute_get();
291  "Processing GET for key `%s'\n",
292  GNUNET_h2s(key));
293 
294  if (GNUNET_OK != GNUNET_SQ_bind(plugin->get_count_stmt, params_count))
295  {
296  LOG_SQLITE(plugin->dbh,
298  "sqlite3_bind_xxx");
299  GNUNET_SQ_reset(plugin->dbh, plugin->get_count_stmt);
300  return 0;
301  }
302  if (SQLITE_ROW != sqlite3_step(plugin->get_count_stmt))
303  {
304  LOG_SQLITE(plugin->dbh,
306  "sqlite_step");
307  GNUNET_SQ_reset(plugin->dbh, plugin->get_count_stmt);
309  "No content found when processing GET for key `%s'\n",
310  GNUNET_h2s(key));
311  return 0;
312  }
313  total = sqlite3_column_int(plugin->get_count_stmt, 0);
314  GNUNET_SQ_reset(plugin->dbh, plugin->get_count_stmt);
315  if ((0 == total) || (NULL == iter))
316  {
317  if (0 == total)
319  "No content found when processing GET for key `%s'\n",
320  GNUNET_h2s(key));
321  return total;
322  }
323 
324  cnt = 0;
326  while (cnt < total)
327  {
328  off = (off + 1) % total;
329  if (GNUNET_OK != GNUNET_SQ_bind(plugin->get_stmt, params_select))
330  {
331  LOG_SQLITE(plugin->dbh,
333  "sqlite3_bind_xxx");
334  GNUNET_SQ_reset(plugin->dbh, plugin->get_stmt);
335  return cnt;
336  }
337  if (SQLITE_ROW != sqlite3_step(plugin->get_stmt))
338  break;
339  if (GNUNET_OK != GNUNET_SQ_extract_result(plugin->get_stmt, rs))
340  {
341  GNUNET_break(0);
342  GNUNET_SQ_reset(plugin->dbh, plugin->get_stmt);
343  break;
344  }
345  if (0 != psize % sizeof(struct GNUNET_PeerIdentity))
346  {
347  GNUNET_break(0);
348  psize = 0;
349  path = NULL;
350  }
351  psize /= sizeof(struct GNUNET_PeerIdentity);
352  cnt++;
354  "Found %u-byte result when processing GET for key `%s'\n",
355  (unsigned int)size,
356  GNUNET_h2s(key));
357  if (GNUNET_OK != iter(iter_cls, key, size, dat, type, exp, psize, path))
358  {
360  GNUNET_SQ_reset(plugin->dbh, plugin->get_stmt);
361  break;
362  }
364  GNUNET_SQ_reset(plugin->dbh, plugin->get_stmt);
365  }
366  GNUNET_SQ_reset(plugin->dbh, plugin->get_stmt);
367  return cnt;
368 }
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:75
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:66
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:85
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 379 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().

380 {
381  struct Plugin *plugin = cls;
382  uint64_t rowid;
383  void *data;
384  size_t dsize;
385  struct GNUNET_HashCode hc;
386  struct GNUNET_TIME_Absolute now;
387  struct GNUNET_SQ_ResultSpec rs[] =
390  GNUNET_SQ_result_spec_variable_size((void **)&data, &dsize),
392  struct GNUNET_SQ_QueryParam params[] = { GNUNET_SQ_query_param_uint64(&rowid),
394  struct GNUNET_SQ_QueryParam time_params[] =
396 
397  LOG(GNUNET_ERROR_TYPE_DEBUG, "Processing DEL\n");
398  now = GNUNET_TIME_absolute_get();
399  if (GNUNET_OK != GNUNET_SQ_bind(plugin->del_expired_stmt, time_params))
400  {
401  LOG_SQLITE(plugin->dbh,
403  "sqlite3_bind");
404  GNUNET_SQ_reset(plugin->dbh, plugin->del_expired_stmt);
405  return GNUNET_SYSERR;
406  }
407  if ((SQLITE_ROW != sqlite3_step(plugin->del_expired_stmt)) ||
409  {
410  GNUNET_SQ_reset(plugin->dbh, plugin->del_expired_stmt);
411  if (SQLITE_ROW != sqlite3_step(plugin->del_select_stmt))
412  {
413  LOG_SQLITE(plugin->dbh,
415  "sqlite3_step");
416  GNUNET_SQ_reset(plugin->dbh, plugin->del_select_stmt);
417  return GNUNET_SYSERR;
418  }
420  {
421  GNUNET_SQ_reset(plugin->dbh, plugin->del_select_stmt);
422  GNUNET_break(0);
423  return GNUNET_SYSERR;
424  }
425  }
427  GNUNET_SQ_reset(plugin->dbh, plugin->del_select_stmt);
428  if (GNUNET_OK != GNUNET_SQ_bind(plugin->del_stmt, params))
429  {
430  LOG_SQLITE(plugin->dbh,
432  "sqlite3_bind");
433  GNUNET_SQ_reset(plugin->dbh, plugin->del_stmt);
434  return GNUNET_SYSERR;
435  }
436  if (SQLITE_DONE != sqlite3_step(plugin->del_stmt))
437  {
438  LOG_SQLITE(plugin->dbh,
440  "sqlite3_step");
441  GNUNET_SQ_reset(plugin->dbh, plugin->del_stmt);
442  return GNUNET_SYSERR;
443  }
444  plugin->num_items--;
445  plugin->env->delete_notify(plugin->env->cls, &hc, dsize + OVERHEAD);
446  GNUNET_SQ_reset(plugin->dbh, plugin->del_stmt);
447  return GNUNET_OK;
448 }
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:75
#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:76
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:85
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 460 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(), Plugin::iter, LOG, Plugin::num_items, plugin, Plugin::size, and type.

Referenced by libgnunet_plugin_datacache_sqlite_init().

463 {
464  struct Plugin *plugin = cls;
465  struct GNUNET_TIME_Absolute exp;
466  size_t size;
467  void *dat;
468  uint32_t off;
469  size_t psize;
470  uint32_t type;
471  struct GNUNET_PeerIdentity *path;
472  struct GNUNET_HashCode key;
473  struct GNUNET_SQ_QueryParam params[] = { GNUNET_SQ_query_param_uint32(&off),
475  struct GNUNET_SQ_ResultSpec rs[] =
478  GNUNET_SQ_result_spec_variable_size((void **)&path, &psize),
482 
483  if (0 == plugin->num_items)
484  return 0;
485  if (NULL == iter)
486  return 1;
487  off =
489  if (GNUNET_OK != GNUNET_SQ_bind(plugin->get_random_stmt, params))
490  {
491  return 0;
492  }
493  if (SQLITE_ROW != sqlite3_step(plugin->get_random_stmt))
494  {
495  GNUNET_break(0);
496  GNUNET_SQ_reset(plugin->dbh, plugin->get_random_stmt);
497  return 0;
498  }
500  {
501  GNUNET_break(0);
502  GNUNET_SQ_reset(plugin->dbh, plugin->get_random_stmt);
503  return 0;
504  }
505  if (0 != psize % sizeof(struct GNUNET_PeerIdentity))
506  {
507  GNUNET_break(0);
508  psize = 0;
509  path = NULL;
510  }
511  psize /= sizeof(struct GNUNET_PeerIdentity);
513  "Found %u-byte result with key %s when processing GET-RANDOM\n",
514  (unsigned int)size,
515  GNUNET_h2s(&key));
516  (void)iter(iter_cls,
517  &key,
518  size,
519  dat,
520  (enum GNUNET_BLOCK_Type)type,
521  exp,
522  psize,
523  path);
525  GNUNET_SQ_reset(plugin->dbh, plugin->get_random_stmt);
526  return 1;
527 }
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:75
#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:66
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:85
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 544 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(), Plugin::iter, LOG, LOG_SQLITE, plugin, Plugin::size, and type.

Referenced by libgnunet_plugin_datacache_sqlite_init().

549 {
550  struct Plugin *plugin = cls;
551  uint32_t num_results32 = num_results;
552  struct GNUNET_TIME_Absolute now;
553  struct GNUNET_TIME_Absolute exp;
554  size_t size;
555  void *dat;
556  unsigned int cnt;
557  size_t psize;
558  uint32_t type;
559  struct GNUNET_HashCode hc;
560  struct GNUNET_PeerIdentity *path;
561  struct GNUNET_SQ_QueryParam params[] =
564  GNUNET_SQ_query_param_uint32(&num_results32),
566  struct GNUNET_SQ_ResultSpec rs[] =
569  GNUNET_SQ_result_spec_variable_size((void **)&path, &psize),
573 
574  now = GNUNET_TIME_absolute_get();
576  "Processing GET_CLOSEST for key `%s'\n",
577  GNUNET_h2s(key));
578  if (GNUNET_OK != GNUNET_SQ_bind(plugin->get_closest_stmt, params))
579  {
580  LOG_SQLITE(plugin->dbh,
582  "sqlite3_bind_xxx");
583  GNUNET_SQ_reset(plugin->dbh, plugin->get_closest_stmt);
584  return 0;
585  }
586  cnt = 0;
587  while (SQLITE_ROW == sqlite3_step(plugin->get_closest_stmt))
588  {
590  {
591  GNUNET_break(0);
592  break;
593  }
594  if (0 != psize % sizeof(struct GNUNET_PeerIdentity))
595  {
596  GNUNET_break(0);
597  psize = 0;
598  path = NULL;
599  }
600  psize /= sizeof(struct GNUNET_PeerIdentity);
601  cnt++;
603  "Found %u-byte result at %s when processing GET_CLOSE\n",
604  (unsigned int)size,
605  GNUNET_h2s(&hc));
606  if (GNUNET_OK != iter(iter_cls, &hc, size, dat, type, exp, psize, path))
607  {
609  break;
610  }
612  }
613  GNUNET_SQ_reset(plugin->dbh, plugin->get_closest_stmt);
614  return cnt;
615 }
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:75
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:66
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:85
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 625 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().

626 {
629  struct Plugin *plugin;
630  char *fn;
631  char *fn_utf8;
632  sqlite3 *dbh;
633  char *emsg;
634 
636  "datacache-sqlite",
637  "IN_MEMORY"))
638  {
639  if (SQLITE_OK != sqlite3_open(":memory:", &dbh))
640  return NULL;
641  fn_utf8 = NULL;
642  }
643  else
644  {
645  fn = GNUNET_DISK_mktemp("gnunet-datacache");
646  if (fn == NULL)
647  {
648  GNUNET_break(0);
649  return NULL;
650  }
651  /* fn should be UTF-8-encoded. If it isn't, it's a bug. */
652  fn_utf8 = GNUNET_strdup(fn);
653  if (SQLITE_OK != sqlite3_open(fn_utf8, &dbh))
654  {
655  GNUNET_free(fn);
656  GNUNET_free(fn_utf8);
657  return NULL;
658  }
659  GNUNET_free(fn);
660  }
661 
662  SQLITE3_EXEC(dbh, "PRAGMA temp_store=MEMORY");
663  SQLITE3_EXEC(dbh, "PRAGMA locking_mode=EXCLUSIVE");
664  SQLITE3_EXEC(dbh, "PRAGMA journal_mode=OFF");
665  SQLITE3_EXEC(dbh, "PRAGMA synchronous=OFF");
666  SQLITE3_EXEC(dbh, "PRAGMA page_size=4092");
668  "datacache-sqlite",
669  "IN_MEMORY"))
670  SQLITE3_EXEC(dbh, "PRAGMA sqlite_temp_store=3");
671 
672  SQLITE3_EXEC(dbh,
673  "CREATE TABLE ds091 ("
674  " type INTEGER NOT NULL DEFAULT 0,"
675  " expire INTEGER NOT NULL,"
676  " key BLOB NOT NULL DEFAULT '',"
677  " prox INTEGER NOT NULL,"
678  " value BLOB NOT NULL,"
679  " path BLOB DEFAULT '')");
680  SQLITE3_EXEC(dbh, "CREATE INDEX idx_hashidx ON ds091 (key,type,expire)");
681  SQLITE3_EXEC(dbh, "CREATE INDEX idx_prox_expire ON ds091 (prox,expire)");
682  SQLITE3_EXEC(dbh, "CREATE INDEX idx_expire_only ON ds091 (expire)");
683  plugin = GNUNET_new(struct Plugin);
684  plugin->env = env;
685  plugin->dbh = dbh;
686  plugin->fn = fn_utf8;
687 
688  if ((SQLITE_OK !=
689  sq_prepare(plugin->dbh,
690  "INSERT INTO ds091 (type, expire, key, prox, value, path) "
691  "VALUES (?, ?, ?, ?, ?, ?)",
692  &plugin->insert_stmt)) ||
693  (SQLITE_OK != sq_prepare(plugin->dbh,
694  "SELECT count(*) FROM ds091 "
695  "WHERE key=? AND type=? AND expire >= ?",
696  &plugin->get_count_stmt)) ||
697  (SQLITE_OK !=
698  sq_prepare(plugin->dbh,
699  "SELECT value,expire,path FROM ds091"
700  " WHERE key=? AND type=? AND expire >= ? LIMIT 1 OFFSET ?",
701  &plugin->get_stmt)) ||
702  (SQLITE_OK != sq_prepare(plugin->dbh,
703  "SELECT _ROWID_,key,value FROM ds091"
704  " WHERE expire < ?"
705  " ORDER BY expire ASC LIMIT 1",
706  &plugin->del_expired_stmt)) ||
707  (SQLITE_OK != sq_prepare(plugin->dbh,
708  "SELECT _ROWID_,key,value FROM ds091"
709  " ORDER BY prox ASC, expire ASC LIMIT 1",
710  &plugin->del_select_stmt)) ||
711  (SQLITE_OK != sq_prepare(plugin->dbh,
712  "DELETE FROM ds091 WHERE _ROWID_=?",
713  &plugin->del_stmt)) ||
714  (SQLITE_OK != sq_prepare(plugin->dbh,
715  "SELECT value,expire,path,key,type FROM ds091 "
716  "ORDER BY key LIMIT 1 OFFSET ?",
717  &plugin->get_random_stmt)) ||
718  (SQLITE_OK !=
719  sq_prepare(plugin->dbh,
720  "SELECT value,expire,path,type,key FROM ds091 "
721  "WHERE key>=? AND expire >= ? ORDER BY KEY ASC LIMIT ?",
722  &plugin->get_closest_stmt)))
723  {
724  LOG_SQLITE(plugin->dbh,
726  "sq_prepare");
727  GNUNET_break(SQLITE_OK == sqlite3_close(plugin->dbh));
728  GNUNET_free(plugin);
729  return NULL;
730  }
731 
733  api->cls = plugin;
734  api->get = &sqlite_plugin_get;
735  api->put = &sqlite_plugin_put;
736  api->del = &sqlite_plugin_del;
739  LOG(GNUNET_ERROR_TYPE_INFO, "Sqlite datacache running\n");
740  return api;
741 }
#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:46
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:465
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:77
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 751 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, and result.

752 {
754  struct Plugin *plugin = api->cls;
755  int result;
756 
757 #if SQLITE_VERSION_NUMBER >= 3007000
758  sqlite3_stmt *stmt;
759 #endif
760 
761 #if !WINDOWS || defined(__CYGWIN__)
762  if ((NULL != plugin->fn) && (0 != unlink(plugin->fn)))
763  LOG_STRERROR_FILE(GNUNET_ERROR_TYPE_WARNING, "unlink", plugin->fn);
764  GNUNET_free_non_null(plugin->fn);
765 #endif
766  sqlite3_finalize(plugin->insert_stmt);
767  sqlite3_finalize(plugin->get_count_stmt);
768  sqlite3_finalize(plugin->get_stmt);
769  sqlite3_finalize(plugin->del_select_stmt);
770  sqlite3_finalize(plugin->del_expired_stmt);
771  sqlite3_finalize(plugin->del_stmt);
772  sqlite3_finalize(plugin->get_random_stmt);
773  sqlite3_finalize(plugin->get_closest_stmt);
774  result = sqlite3_close(plugin->dbh);
775 #if SQLITE_VERSION_NUMBER >= 3007000
776  if (SQLITE_BUSY == result)
777  {
779  _(
780  "Tried to close sqlite without finalizing all prepared statements.\n"));
781  stmt = sqlite3_next_stmt(plugin->dbh, NULL);
782  while (NULL != stmt)
783  {
784  result = sqlite3_finalize(stmt);
785  if (result != SQLITE_OK)
787  "Failed to close statement %p: %d\n",
788  stmt,
789  result);
790  stmt = sqlite3_next_stmt(plugin->dbh, NULL);
791  }
792  result = sqlite3_close(plugin->dbh);
793  }
794 #endif
795  if (SQLITE_OK != result)
796  LOG_SQLITE(plugin->dbh, GNUNET_ERROR_TYPE_ERROR, "sqlite3_close");
797 
798  GNUNET_free(plugin);
799  GNUNET_free(api);
800  return NULL;
801 }
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 _(String)
GNU gettext support macro.
Definition: platform.h:181
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.