gnunet_sq_lib.h File Reference

helper functions for Sqlite3 DB interactions More...

#include <sqlite3.h>
#include "gnunet_util_lib.h"

Include dependency graph for gnunet_sq_lib.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	GNUNET_SQ_QueryParam
	Description of a DB query parameter. More...
struct	GNUNET_SQ_ResultSpec
	Description of a DB result cell. More...
struct	GNUNET_SQ_PrepareStatement
	Information needed to run a list of SQL statements using GNUNET_SQ_exec_statements(). More...
struct	GNUNET_SQ_ExecuteStatement
	Information needed to run a list of SQL statements using GNUNET_SQ_exec_statements(). More...

Macros
#define	GNUNET_SQ_query_param_end   { NULL, NULL, NULL, 0, 0 }
	End of query parameter specification. More...
#define	GNUNET_SQ_query_param_auto_from_type(x)   GNUNET_SQ_query_param_fixed_size ((x), sizeof(*(x)))
	Generate fixed-size query parameter with size determined by variable type. More...
#define	GNUNET_SQ_result_spec_end   { NULL, NULL, NULL, NULL, 0, NULL, 0 }
	End of result parameter specification. More...
#define	GNUNET_SQ_result_spec_auto_from_type(dst)   GNUNET_SQ_result_spec_fixed_size ((dst), sizeof(*(dst)))
	We expect a fixed-size result, with size determined by the type of * dst More...
#define	GNUNET_SQ_PREPARE_END   { NULL, NULL }
	Terminator for executable statement list. More...
#define	GNUNET_SQ_EXECUTE_STATEMENT_END   { NULL, GNUNET_SYSERR }
	Terminator for executable statement list. More...

Typedefs
typedef enum GNUNET_GenericReturnValue(*	GNUNET_SQ_QueryConverter) (void *cls, const void *data, size_t data_len, sqlite3_stmt *stmt, unsigned int off)
	Function called to convert input argument into SQL parameters. More...
typedef enum GNUNET_GenericReturnValue(*	GNUNET_SQ_ResultConverter) (void *cls, sqlite3_stmt *result, unsigned int column, size_t *dst_size, void *dst)
	Extract data from a Postgres database result at row row. More...
typedef void(*	GNUNET_SQ_ResultCleanup) (void *cls)
	Function called to clean up memory allocated by a GNUNET_SQ_ResultConverter. More...

Functions
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. More...
struct GNUNET_SQ_QueryParam	GNUNET_SQ_query_param_string (const char *ptr)
	Generate query parameter for a string. More...
struct GNUNET_SQ_QueryParam	GNUNET_SQ_query_param_rsa_public_key (const struct GNUNET_CRYPTO_RsaPublicKey *x)
	Generate query parameter for an RSA public key. More...
struct GNUNET_SQ_QueryParam	GNUNET_SQ_query_param_rsa_signature (const struct GNUNET_CRYPTO_RsaSignature *x)
	Generate query parameter for an RSA signature. More...
struct GNUNET_SQ_QueryParam	GNUNET_SQ_query_param_absolute_time (const struct GNUNET_TIME_Absolute *x)
	Generate query parameter for an absolute time value. More...
struct GNUNET_SQ_QueryParam	GNUNET_SQ_query_param_absolute_time_nbo (const struct GNUNET_TIME_AbsoluteNBO *x)
	Generate query parameter for an absolute time value. More...
struct GNUNET_SQ_QueryParam	GNUNET_SQ_query_param_uint16 (const uint16_t *x)
	Generate query parameter for an uint16_t in host byte order. More...
struct GNUNET_SQ_QueryParam	GNUNET_SQ_query_param_uint32 (const uint32_t *x)
	Generate query parameter for an uint32_t in host byte order. More...
struct GNUNET_SQ_QueryParam	GNUNET_SQ_query_param_uint64 (const uint64_t *x)
	Generate query parameter for an uint16_t in host byte order. More...
enum GNUNET_GenericReturnValue	GNUNET_SQ_bind (sqlite3_stmt *stmt, const struct GNUNET_SQ_QueryParam *params)
	Execute binding operations for a prepared statement. More...
void	GNUNET_SQ_reset (sqlite3 *dbh, sqlite3_stmt *stmt)
	Reset stmt and log error. More...
struct GNUNET_SQ_ResultSpec	GNUNET_SQ_result_spec_variable_size (void **dst, size_t *sptr)
	Variable-size result expected. More...
struct GNUNET_SQ_ResultSpec	GNUNET_SQ_result_spec_fixed_size (void *dst, size_t dst_size)
	Fixed-size result expected. More...
struct GNUNET_SQ_ResultSpec	GNUNET_SQ_result_spec_string (char **dst)
	0-terminated string expected. More...
struct GNUNET_SQ_ResultSpec	GNUNET_SQ_result_spec_rsa_public_key (struct GNUNET_CRYPTO_RsaPublicKey **rsa)
	RSA public key expected. More...
struct GNUNET_SQ_ResultSpec	GNUNET_SQ_result_spec_rsa_signature (struct GNUNET_CRYPTO_RsaSignature **sig)
	RSA signature expected. More...
struct GNUNET_SQ_ResultSpec	GNUNET_SQ_result_spec_absolute_time (struct GNUNET_TIME_Absolute *at)
	Absolute time expected. More...
struct GNUNET_SQ_ResultSpec	GNUNET_SQ_result_spec_absolute_time_nbo (struct GNUNET_TIME_AbsoluteNBO *at)
	Absolute time expected. More...
struct GNUNET_SQ_ResultSpec	GNUNET_SQ_result_spec_uint16 (uint16_t *u16)
	uint16_t expected. More...
struct GNUNET_SQ_ResultSpec	GNUNET_SQ_result_spec_uint32 (uint32_t *u32)
	uint32_t expected. More...
struct GNUNET_SQ_ResultSpec	GNUNET_SQ_result_spec_uint64 (uint64_t *u64)
	uint64_t expected. More...
enum GNUNET_GenericReturnValue	GNUNET_SQ_extract_result (sqlite3_stmt *result, struct GNUNET_SQ_ResultSpec *rs)
	Extract results from a query result according to the given specification. More...
void	GNUNET_SQ_cleanup_result (struct GNUNET_SQ_ResultSpec *rs)
	Free all memory that was allocated in rs during GNUNET_SQ_extract_result(). More...
struct GNUNET_SQ_PrepareStatement	GNUNET_SQ_make_prepare (const char *sql, sqlite3_stmt **pstmt)
	Create a struct GNUNET_SQ_PrepareStatement More...
enum GNUNET_GenericReturnValue	GNUNET_SQ_prepare (sqlite3 *dbh, const struct GNUNET_SQ_PrepareStatement *ps)
	Prepare all statements given in the (NULL,NULL)-terminated array at ps. More...
struct GNUNET_SQ_ExecuteStatement	GNUNET_SQ_make_execute (const char *sql)
	Create a struct GNUNET_SQ_ExecuteStatement where errors are fatal. More...
struct GNUNET_SQ_ExecuteStatement	GNUNET_SQ_make_try_execute (const char *sql)
	Create a struct GNUNET_SQ_ExecuteStatement where errors should be tolerated. More...
enum GNUNET_GenericReturnValue	GNUNET_SQ_exec_statements (sqlite3 *dbh, const struct GNUNET_SQ_ExecuteStatement *es)
	Request execution of an array of statements es from Postgres. More...

Detailed Description

helper functions for Sqlite3 DB interactions

Author

Christian Grothoff

Definition in file gnunet_sq_lib.h.

Macro Definition Documentation

GNUNET_SQ_query_param_end

#define GNUNET_SQ_query_param_end   { NULL, NULL, NULL, 0, 0 }

End of query parameter specification.

Definition at line 87 of file gnunet_sq_lib.h.

GNUNET_SQ_query_param_auto_from_type

#define GNUNET_SQ_query_param_auto_from_type

(

x

)

GNUNET_SQ_query_param_fixed_size ((x), sizeof(*(x)))

Generate fixed-size query parameter with size determined by variable type.

Parameters

x	pointer to the query parameter to pass.

Definition at line 117 of file gnunet_sq_lib.h.

GNUNET_SQ_result_spec_end

#define GNUNET_SQ_result_spec_end   { NULL, NULL, NULL, NULL, 0, NULL, 0 }

End of result parameter specification.

Returns

array last entry for the result specification to use

Definition at line 302 of file gnunet_sq_lib.h.

GNUNET_SQ_result_spec_auto_from_type

#define GNUNET_SQ_result_spec_auto_from_type

(

dst

)

GNUNET_SQ_result_spec_fixed_size ((dst), sizeof(*(dst)))

We expect a fixed-size result, with size determined by the type of * dst

Parameters

dst	point to where to store the result, type fits expected result size

Returns

array entry for the result specification to use

Definition at line 335 of file gnunet_sq_lib.h.

GNUNET_SQ_PREPARE_END

#define GNUNET_SQ_PREPARE_END   { NULL, NULL }

Terminator for executable statement list.

Definition at line 479 of file gnunet_sq_lib.h.

GNUNET_SQ_EXECUTE_STATEMENT_END

#define GNUNET_SQ_EXECUTE_STATEMENT_END   { NULL, GNUNET_SYSERR }

Terminator for executable statement list.

Definition at line 531 of file gnunet_sq_lib.h.

Typedef Documentation

GNUNET_SQ_QueryConverter

typedef enum GNUNET_GenericReturnValue(* GNUNET_SQ_QueryConverter) (void *cls, const void *data, size_t data_len, sqlite3_stmt *stmt, unsigned int off)

Function called to convert input argument into SQL parameters.

Parameters

cls	closure
data	pointer to input argument
data_len	number of bytes in data (if applicable)
stmt	sqlite statement to bind parameters for
off	offset of the argument to bind in stmt, numbered from 1, so immediately suitable for passing to sqlite3_bind-functions.

Returns

GNUNET_SYSERR on error, GNUNET_OK on success

Definition at line 1 of file gnunet_sq_lib.h.

GNUNET_SQ_ResultConverter

typedef enum GNUNET_GenericReturnValue(* GNUNET_SQ_ResultConverter) (void *cls, sqlite3_stmt *result, unsigned int column, size_t *dst_size, void *dst)

Extract data from a Postgres database result at row row.

Parameters

	cls	closure
	result	where to extract data from
	column	column to extract data from
[in,out]	dst_size	where to store size of result, may be NULL
[out]	dst	where to store the result

Returns

GNUNET_YES if all results could be extracted GNUNET_SYSERR if a result was invalid (non-existing field or NULL)

Definition at line 210 of file gnunet_sq_lib.h.

GNUNET_SQ_ResultCleanup

typedef void(* GNUNET_SQ_ResultCleanup) (void *cls)

Function called to clean up memory allocated by a GNUNET_SQ_ResultConverter.

Parameters

cls

closure

Definition at line 246 of file gnunet_sq_lib.h.

Function Documentation

GNUNET_SQ_query_param_fixed_size()

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.

Parameters

ptr	pointer to the query parameter to pass
ptr_size	number of bytes in ptr

Definition at line 41 of file sq_query_helper.c.

{
  struct GNUNET_SQ_QueryParam qp = {
    .conv = &bind_fixed_blob,
    .data = ptr,
    .size = ptr_size,
    .num_params = 1
  };
 
  return qp;
}

Referenced by namecache_sqlite_cache_block(), peerstore_sqlite_store_record(), sqlite_plugin_put(), and sqlite_plugin_remove_key().

Here is the caller graph for this function:

GNUNET_SQ_query_param_string()

struct GNUNET_SQ_QueryParam GNUNET_SQ_query_param_string

(

const char *

ptr

)

Generate query parameter for a string.

Parameters

ptr	pointer to the string query parameter to pass

Definition at line 92 of file sq_query_helper.c.

{
  struct GNUNET_SQ_QueryParam qp = {
    .conv = &bind_string,
    .data = ptr,
    .num_params = 1
  };
 
  return qp;
}

Referenced by peerstore_sqlite_delete_records(), peerstore_sqlite_iterate_records(), and peerstore_sqlite_store_record().

Here is the caller graph for this function:

GNUNET_SQ_query_param_rsa_public_key()

struct GNUNET_SQ_QueryParam GNUNET_SQ_query_param_rsa_public_key

(

const struct GNUNET_CRYPTO_RsaPublicKey *

x

)

Generate query parameter for an RSA public key.

The database must contain a BLOB type in the respective position.

Parameters

x	the query parameter to pass.

Definition at line 147 of file sq_query_helper.c.

{
  struct GNUNET_SQ_QueryParam qp = {
    .conv = &bind_rsa_pub,
    .data = x,
    .num_params = 1
  };
 
  return qp;
}

GNUNET_SQ_query_param_rsa_signature()

struct GNUNET_SQ_QueryParam GNUNET_SQ_query_param_rsa_signature

(

const struct GNUNET_CRYPTO_RsaSignature *

x

)

Generate query parameter for an RSA signature.

The database must contain a BLOB type in the respective position.

Parameters

x	the query parameter to pass

Definition at line 207 of file sq_query_helper.c.

{
  struct GNUNET_SQ_QueryParam qp = {
    .conv = &bind_rsa_sig,
    .data = x,
    .num_params = 1
  };
 
  return qp;
}

GNUNET_SQ_query_param_absolute_time()

struct GNUNET_SQ_QueryParam GNUNET_SQ_query_param_absolute_time

(

const struct GNUNET_TIME_Absolute *

x

)

Generate query parameter for an absolute time value.

The database must store a 64-bit integer.

Parameters

x	pointer to the query parameter to pass

Definition at line 266 of file sq_query_helper.c.

{
  struct GNUNET_SQ_QueryParam qp = {
    .conv = &bind_abstime,
    .data = x,
    .size = sizeof(struct GNUNET_TIME_Absolute),
    .num_params = 1
  };
 
  return qp;
}

Referenced by get_any(), get_typed(), namecache_sqlite_cache_block(), namecache_sqlite_expire_blocks(), peerstore_sqlite_expire_records(), peerstore_sqlite_store_record(), sqlite_plugin_get_closest(), sqlite_plugin_get_expiration(), and sqlite_plugin_put().

Here is the caller graph for this function:

GNUNET_SQ_query_param_absolute_time_nbo()

struct GNUNET_SQ_QueryParam GNUNET_SQ_query_param_absolute_time_nbo

(

const struct GNUNET_TIME_AbsoluteNBO *

x

)

Generate query parameter for an absolute time value.

The database must store a 64-bit integer.

Parameters

x	pointer to the query parameter to pass

Definition at line 320 of file sq_query_helper.c.

{
  struct GNUNET_SQ_QueryParam qp = {
    .conv = &bind_nbotime,
    .data = x,
    .size = sizeof(struct GNUNET_TIME_AbsoluteNBO),
    .num_params = 1
  };
 
  return qp;
}

GNUNET_SQ_query_param_uint16()

struct GNUNET_SQ_QueryParam GNUNET_SQ_query_param_uint16

(

const uint16_t *

x

)

Generate query parameter for an uint16_t in host byte order.

Parameters

x	pointer to the query parameter to pass

Definition at line 375 of file sq_query_helper.c.

{
  struct GNUNET_SQ_QueryParam qp = {
    .conv = &bind_u16,
    .data = x,
    .size = sizeof(uint16_t),
    .num_params = 1
  };
 
  return qp;
}

GNUNET_SQ_query_param_uint32()

struct GNUNET_SQ_QueryParam GNUNET_SQ_query_param_uint32

(

const uint32_t *

x

)

Generate query parameter for an uint32_t in host byte order.

Parameters

x	pointer to the query parameter to pass

Definition at line 424 of file sq_query_helper.c.

{
  struct GNUNET_SQ_QueryParam qp = {
    .conv = &bind_u32,
    .data = x,
    .size = sizeof(uint32_t),
    .num_params = 1
  };
 
  return qp;
}

Referenced by get_any(), get_typed(), sqlite_plugin_get_closest(), sqlite_plugin_get_key(), sqlite_plugin_get_replication(), sqlite_plugin_get_zero_anonymity(), and sqlite_plugin_put().

Here is the caller graph for this function:

GNUNET_SQ_query_param_uint64()

struct GNUNET_SQ_QueryParam GNUNET_SQ_query_param_uint64

(

const uint64_t *

x

)

Generate query parameter for an uint16_t in host byte order.

Parameters

x	pointer to the query parameter to pass

Definition at line 473 of file sq_query_helper.c.

{
  struct GNUNET_SQ_QueryParam qp = {
    .conv = &bind_u64,
    .data = x,
    .size = sizeof(uint64_t),
    .num_params = 1
  };
 
  return qp;
}

Referenced by delete_by_rowid(), sqlite_plugin_get_key(), sqlite_plugin_get_replication(), sqlite_plugin_get_zero_anonymity(), and sqlite_plugin_put().

Here is the caller graph for this function:

GNUNET_SQ_bind()

enum GNUNET_GenericReturnValue GNUNET_SQ_bind	(	sqlite3_stmt *	stmt,
		const struct GNUNET_SQ_QueryParam *	params
	)

Execute binding operations for a prepared statement.

Parameters

db_conn	database connection
params	parameters to the statement

Returns

GNUNET_OK on success, GNUNET_SYSERR on error

Definition at line 1 of file sq.c.

{
  unsigned int j;
 
  j = 1;
  for (unsigned int i = 0; NULL != params[i].conv; i++)
  {
    if (GNUNET_OK !=
        params[i].conv (params[i].conv_cls,
                        params[i].data,
                        params[i].size,
                        stmt,
                        j))
    {
      GNUNET_log_from (GNUNET_ERROR_TYPE_WARNING,
                       "sq",
                       _ ("Failure to bind %u-th SQL parameter\n"),
                       i);
      if (SQLITE_OK !=
          sqlite3_reset (stmt))
      {
        GNUNET_log_from (GNUNET_ERROR_TYPE_WARNING,
                         "sq",
                         _ ("Failure in sqlite3_reset (!)\n"));
        return GNUNET_SYSERR;
      }
    }
    GNUNET_assert (0 != params[i].num_params);
    j += params[i].num_params;
  }
  return GNUNET_OK;
}

References _, conv, GNUNET_SQ_QueryParam::conv, data, GNUNET_assert, GNUNET_ERROR_TYPE_WARNING, GNUNET_log_from, GNUNET_OK, GNUNET_SYSERR, GNUNET_SQ_QueryParam::num_params, and size.

Referenced by delete_by_rowid(), get_any(), get_typed(), namecache_sqlite_cache_block(), namecache_sqlite_expire_blocks(), namecache_sqlite_lookup_block(), peerstore_sqlite_delete_records(), peerstore_sqlite_expire_records(), peerstore_sqlite_iterate_records(), peerstore_sqlite_store_record(), sqlite_plugin_get_closest(), sqlite_plugin_get_expiration(), sqlite_plugin_get_key(), sqlite_plugin_get_replication(), sqlite_plugin_get_zero_anonymity(), sqlite_plugin_put(), and sqlite_plugin_remove_key().

Here is the caller graph for this function:

GNUNET_SQ_reset()

void GNUNET_SQ_reset	(	sqlite3 *	dbh,
		sqlite3_stmt *	stmt
	)

Reset stmt and log error.

Parameters

dbh	database handle
stmt	statement to reset

Definition at line 120 of file sq.c.

{
  if (SQLITE_OK !=
      sqlite3_reset (stmt))
    GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
                     "sqlite",
                     _ ("Failed to reset sqlite statement with error: %s\n"),
                     sqlite3_errmsg (dbh));
}

References _, GNUNET_ERROR_TYPE_BULK, GNUNET_ERROR_TYPE_ERROR, and GNUNET_log_from.

Referenced by delete_by_rowid(), execute_get(), get_any(), get_typed(), namecache_sqlite_cache_block(), namecache_sqlite_expire_blocks(), namecache_sqlite_lookup_block(), peerstore_sqlite_delete_records(), peerstore_sqlite_expire_records(), peerstore_sqlite_iterate_records(), peerstore_sqlite_store_record(), sqlite_plugin_get_closest(), sqlite_plugin_get_replication(), sqlite_plugin_put(), and sqlite_plugin_remove_key().

Here is the caller graph for this function:

GNUNET_SQ_result_spec_variable_size()

struct GNUNET_SQ_ResultSpec GNUNET_SQ_result_spec_variable_size	(	void **	dst,
		size_t *	sptr
	)

Variable-size result expected.

Parameters

[out]	dst	where to store the result, allocated
[out]	sptr	where to store the size of dst

Returns

array entry for the result specification to use

Definition at line 99 of file sq_result_helper.c.

{
  struct GNUNET_SQ_ResultSpec rs = {
    .conv = &extract_var_blob,
    .cleaner = &clean_var_blob,
    .dst = dst,
    .cls = dst,
    .result_size = sptr,
    .num_params = 1
  };
 
  return rs;
}

Referenced by execute_get(), get_any(), get_typed(), namecache_sqlite_lookup_block(), peerstore_sqlite_iterate_records(), and sqlite_plugin_get_closest().

Here is the caller graph for this function:

GNUNET_SQ_result_spec_fixed_size()

struct GNUNET_SQ_ResultSpec GNUNET_SQ_result_spec_fixed_size	(	void *	dst,
		size_t	dst_size
	)

Fixed-size result expected.

Parameters

[out]	dst	where to store the result
	dst_size	number of bytes in dst

Returns

array entry for the result specification to use

Definition at line 148 of file sq_result_helper.c.

{
  struct GNUNET_SQ_ResultSpec rs = {
    .conv = &extract_fixed_blob,
    .dst = dst,
    .dst_size = dst_size,
    .num_params = 1
  };
 
  return rs;
}

GNUNET_SQ_result_spec_string()

struct GNUNET_SQ_ResultSpec GNUNET_SQ_result_spec_string

(

char **

dst

)

0-terminated string expected.

Parameters

[out]

dst

where to store the result, allocated

Returns

array entry for the result specification to use

Definition at line 269 of file sq_result_helper.c.

{
  struct GNUNET_SQ_ResultSpec rs = {
    .conv = &extract_utf8_string,
    .cleaner = &clean_utf8_string,
    .cls = dst,
    .dst = dst,
    .num_params = 1
  };
 
  return rs;
}

Referenced by peerstore_sqlite_iterate_records().

Here is the caller graph for this function:

GNUNET_SQ_result_spec_rsa_public_key()

struct GNUNET_SQ_ResultSpec GNUNET_SQ_result_spec_rsa_public_key

(

struct GNUNET_CRYPTO_RsaPublicKey **

rsa

)

RSA public key expected.

Parameters

[out]

rsa

where to store the result

Returns

array entry for the result specification to use

Definition at line 362 of file sq_result_helper.c.

{
  struct GNUNET_SQ_ResultSpec rs = {
    .conv = &extract_rsa_pub,
    .cleaner = &clean_rsa_pub,
    .dst = rsa,
    .cls = rsa,
    .num_params = 1
  };
 
  return rs;
}

GNUNET_SQ_result_spec_rsa_signature()

struct GNUNET_SQ_ResultSpec GNUNET_SQ_result_spec_rsa_signature

(

struct GNUNET_CRYPTO_RsaSignature **

sig

)

RSA signature expected.

Parameters

[out]

sig

where to store the result;

Returns

array entry for the result specification to use

Definition at line 455 of file sq_result_helper.c.

{
  struct GNUNET_SQ_ResultSpec rs = {
    .conv = &extract_rsa_sig,
    .cleaner = &clean_rsa_sig,
    .dst = sig,
    .cls = sig,
    .num_params = 1
  };
 
  return rs;
}

GNUNET_SQ_result_spec_absolute_time()

struct GNUNET_SQ_ResultSpec GNUNET_SQ_result_spec_absolute_time

(

struct GNUNET_TIME_Absolute *

at

)

Absolute time expected.

Parameters

[out]

at

where to store the result

Returns

array entry for the result specification to use

Definition at line 501 of file sq_result_helper.c.

{
  struct GNUNET_SQ_ResultSpec rs = {
    .conv = &extract_abs_time,
    .dst = at,
    .dst_size = sizeof(struct GNUNET_TIME_Absolute),
    .num_params = 1
  };
 
  return rs;
}

Referenced by execute_get(), get_any(), get_typed(), peerstore_sqlite_iterate_records(), and sqlite_plugin_get_closest().

Here is the caller graph for this function:

GNUNET_SQ_result_spec_absolute_time_nbo()

struct GNUNET_SQ_ResultSpec GNUNET_SQ_result_spec_absolute_time_nbo

(

struct GNUNET_TIME_AbsoluteNBO *

at

)

Absolute time expected.

Parameters

[out]

at

where to store the result

Returns

array entry for the result specification to use

Definition at line 560 of file sq_result_helper.c.

{
  struct GNUNET_SQ_ResultSpec rs = {
    .conv = &extract_abs_time_nbo,
    .dst = at,
    .dst_size = sizeof(struct GNUNET_TIME_AbsoluteNBO),
    .num_params = 1
  };
 
  return rs;
}

GNUNET_SQ_result_spec_uint16()

struct GNUNET_SQ_ResultSpec GNUNET_SQ_result_spec_uint16

(

uint16_t *

u16

)

uint16_t expected.

Parameters

[out]

u16

where to store the result

Returns

array entry for the result specification to use

Definition at line 619 of file sq_result_helper.c.

{
  struct GNUNET_SQ_ResultSpec rs = {
    .conv = &extract_uint16,
    .dst = u16,
    .dst_size = sizeof(uint16_t),
    .num_params = 1
  };
 
  return rs;
}

GNUNET_SQ_result_spec_uint32()

struct GNUNET_SQ_ResultSpec GNUNET_SQ_result_spec_uint32

(

uint32_t *

u32

)

uint32_t expected.

Parameters

[out]

u32

where to store the result

Returns

array entry for the result specification to use

Definition at line 681 of file sq_result_helper.c.

{
  struct GNUNET_SQ_ResultSpec rs = {
    .conv = &extract_uint32,
    .dst = u32,
    .dst_size = sizeof(uint32_t),
    .num_params = 1
  };
 
  return rs;
}

Referenced by execute_get(), get_any(), get_typed(), and sqlite_plugin_get_closest().

Here is the caller graph for this function:

GNUNET_SQ_result_spec_uint64()

struct GNUNET_SQ_ResultSpec GNUNET_SQ_result_spec_uint64

(

uint64_t *

u64

)

uint64_t expected.

Parameters

[out]

u64

where to store the result

Returns

array entry for the result specification to use

Definition at line 743 of file sq_result_helper.c.

{
  struct GNUNET_SQ_ResultSpec rs = {
    .conv = &extract_uint64,
    .dst = u64,
    .dst_size = sizeof(uint64_t),
    .num_params = 1
  };
 
  return rs;
}

Referenced by execute_get().

Here is the caller graph for this function:

GNUNET_SQ_extract_result()

enum GNUNET_GenericReturnValue GNUNET_SQ_extract_result	(	sqlite3_stmt *	result,
		struct GNUNET_SQ_ResultSpec *	rs
	)

Extract results from a query result according to the given specification.

Parameters

	result	result to process
[in,out]	rs	result specification to extract for

Returns

GNUNET_OK if all results could be extracted GNUNET_SYSERR if a result was invalid (non-existing field)

Definition at line 1 of file sq.c.

{
  unsigned int j = 0;
 
  for (unsigned int i = 0; NULL != rs[i].conv; i++)
  {
    if (NULL == rs[i].result_size)
      rs[i].result_size = &rs[i].dst_size;
    if (GNUNET_OK !=
        rs[i].conv (rs[i].cls,
                    result,
                    j,
                    rs[i].result_size,
                    rs[i].dst))
    {
      for (unsigned int k = 0; k < i; k++)
        if (NULL != rs[k].cleaner)
          rs[k].cleaner (rs[k].cls);
      return GNUNET_SYSERR;
    }
    GNUNET_assert (0 != rs[i].num_params);
    j += rs[i].num_params;
  }
  return GNUNET_OK;
}

Referenced by execute_get(), get_any(), get_typed(), namecache_sqlite_lookup_block(), peerstore_sqlite_iterate_records(), sqlite_plugin_get_closest(), and sqlite_plugin_get_keys().

Here is the caller graph for this function:

GNUNET_SQ_cleanup_result()

void GNUNET_SQ_cleanup_result

(

struct GNUNET_SQ_ResultSpec *

rs

)

Free all memory that was allocated in rs during GNUNET_SQ_extract_result().

Parameters

rs	reult specification to clean up

Definition at line 105 of file sq.c.

{
  for (unsigned int i = 0; NULL != rs[i].conv; i++)
    if (NULL != rs[i].cleaner)
      rs[i].cleaner (rs[i].cls);
}

References GNUNET_SQ_ResultSpec::cleaner, and GNUNET_SQ_ResultSpec::conv.

Referenced by execute_get(), get_any(), get_typed(), namecache_sqlite_lookup_block(), peerstore_sqlite_iterate_records(), and sqlite_plugin_get_closest().

Here is the caller graph for this function:

GNUNET_SQ_make_prepare()

struct GNUNET_SQ_PrepareStatement GNUNET_SQ_make_prepare	(	const char *	sql,
		sqlite3_stmt **	pstmt
	)

Create a struct GNUNET_SQ_PrepareStatement

Parameters

sql	actual SQL statement
pstmt	where to store the handle

Returns

initialized struct

Definition at line 1 of file sq_prepare.c.

{
  struct GNUNET_SQ_PrepareStatement ps = {
    .sql = sql,
    .pstmt = pstmt
  };
 
  return ps;
}

References GNUNET_SQ_PrepareStatement::pstmt, and GNUNET_SQ_PrepareStatement::sql.

Referenced by database_setup().

Here is the caller graph for this function:

GNUNET_SQ_prepare()

enum GNUNET_GenericReturnValue GNUNET_SQ_prepare	(	sqlite3 *	dbh,
		const struct GNUNET_SQ_PrepareStatement *	ps
	)

Prepare all statements given in the (NULL,NULL)-terminated array at ps.

Parameters

dbh	database handle
ps	array of statements to prepare

Returns

GNUNET_OK on success

Definition at line 1 of file sq_prepare.c.

{
  for (unsigned int i = 0; NULL != ps[i].sql; i++)
  {
    const char *epos = NULL;
    int ret;
 
    if (SQLITE_OK !=
        (ret = sqlite3_prepare_v2 (dbh,
                                   ps[i].sql,
                                   strlen (ps[i].sql),
                                   ps[i].pstmt,
                                   &epos)))
    {
      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                  "Failed to prepare SQL `%s': error %d at %s\n",
                  ps[i].sql,
                  ret,
                  epos);
      return GNUNET_SYSERR;
    }
  }
  return GNUNET_OK;
}

Referenced by database_setup().

Here is the caller graph for this function:

GNUNET_SQ_make_execute()

struct GNUNET_SQ_ExecuteStatement GNUNET_SQ_make_execute

(

const char *

sql

)

Create a struct GNUNET_SQ_ExecuteStatement where errors are fatal.

Parameters

sql	actual SQL statement

Returns

initialized struct

Definition at line 1 of file sq_exec.c.

{
  struct GNUNET_SQ_ExecuteStatement es = {
    .sql = sql,
    .ignore_errors = GNUNET_NO
  };
 
  return es;
}

Referenced by database_setup().

Here is the caller graph for this function:

GNUNET_SQ_make_try_execute()

struct GNUNET_SQ_ExecuteStatement GNUNET_SQ_make_try_execute

(

const char *

sql

)

Create a struct GNUNET_SQ_ExecuteStatement where errors should be tolerated.

Parameters

sql	actual SQL statement

Returns

initialized struct

Definition at line 1 of file sq_exec.c.

{
  struct GNUNET_SQ_ExecuteStatement es = {
    .sql = sql,
    .ignore_errors = GNUNET_YES
  };
 
  return es;
}

Referenced by database_setup().

Here is the caller graph for this function:

GNUNET_SQ_exec_statements()

enum GNUNET_GenericReturnValue GNUNET_SQ_exec_statements	(	sqlite3 *	dbh,
		const struct GNUNET_SQ_ExecuteStatement *	es
	)

Request execution of an array of statements es from Postgres.

Parameters

dbh	database to execute the statements over
es	GNUNET_PQ_PREPARED_STATEMENT_END-terminated array of prepared statements.

Returns

GNUNET_OK on success (modulo statements where errors can be ignored) GNUNET_SYSERR on error

Definition at line 1 of file sq_exec.c.

{
  for (unsigned int i = 0; NULL != es[i].sql; i++)
  {
    char *emsg = NULL;
 
    if (SQLITE_OK !=
        sqlite3_exec (dbh,
                      es[i].sql,
                      NULL,
                      NULL,
                      &emsg))
    {
      if (es[i].ignore_errors)
      {
        GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                    "Failed to run SQL `%s': %s\n",
                    es[i].sql,
                    emsg);
      }
      else
      {
        GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                    "Failed to run SQL `%s': %s\n",
                    es[i].sql,
                    emsg);
        sqlite3_free (emsg);
        return GNUNET_SYSERR;
      }
      sqlite3_free (emsg);
    }
  }
  return GNUNET_OK;
}

References GNUNET_NO, and GNUNET_SQ_ExecuteStatement::sql.

Referenced by database_setup().

Here is the caller graph for this function: