MySQL library

Helper library to access a MySQL database. More...

Collaboration diagram for MySQL library:

Data Structures
struct	GNUNET_MY_QueryParam
	Information we pass to GNUNET_MY_exec_prepared() to initialize the arguments of the prepared statement. More...
struct	GNUNET_MY_ResultSpec
	Information we pass to GNUNET_MY_extract_result() to initialize the arguments of the prepared statement. More...

Macros
#define	GNUNET_MY_query_param_end   { NULL, NULL, NULL, 0, NULL, 0 }
	End of query parameter specification. More...
#define	GNUNET_MY_result_spec_end   { NULL, NULL, NULL, 0, NULL, 0, 0 }
	End of result speceter specification. More...
#define	GNUNET_MY_query_param_auto_from_type(x)   GNUNET_MY_query_param_fixed_size ((x), sizeof(*(x)))
	Generate fixed-size query parameter with size determined by variable type. More...
#define	GNUNET_MY_result_spec_auto_from_type(dst)   GNUNET_MY_result_spec_fixed_size ((dst), sizeof(*(dst)))
	We expect a fixed-size result, with size determined by the type of * dst More...
#define	MYSQL_BOOL   my_bool

Typedefs
typedef int(*	GNUNET_MY_QueryConverter) (void *cls, const struct GNUNET_MY_QueryParam *qp, MYSQL_BIND *qbind)
	Function called to convert input argument into SQL parameters. More...
typedef void(*	GNUNET_MY_QueryCleanup) (void *cls, MYSQL_BIND *qbind)
	Function called to cleanup result data. More...
typedef int(*	GNUNET_MY_ResultConverter) (void *cls, struct GNUNET_MY_ResultSpec *rs, MYSQL_STMT *stmt, unsigned int column, MYSQL_BIND *results)
	Function called to convert input argument into SQL parameters. More...
typedef void(*	GNUNET_MY_ResultCleanup) (void *cls, struct GNUNET_MY_ResultSpec *rs)
	Function called to cleanup result data. More...
typedef int(*	GNUNET_MYSQL_DataProcessor) (void *cls, unsigned int num_values, MYSQL_BIND *values)
	Type of a callback that will be called for each data set returned from MySQL. More...

Functions
struct GNUNET_MY_QueryParam	GNUNET_MY_query_param_fixed_size (const void *ptr, size_t ptr_size)
	Generate query parameter for a buffer ptr of ptr_size bytes.FG. More...
int	GNUNET_MY_exec_prepared (struct GNUNET_MYSQL_Context *mc, struct GNUNET_MYSQL_StatementHandle *sh, struct GNUNET_MY_QueryParam *params)
	Run a prepared SELECT statement. More...
struct GNUNET_MY_ResultSpec	GNUNET_MY_result_spec_fixed_size (void *ptr, size_t ptr_size)
	Obtain fixed size result of ptr_size bytes from MySQL, store in already allocated buffer at ptr. More...
struct GNUNET_MY_QueryParam	GNUNET_MY_query_param_string (const char *ptr)
	Generate query parameter for a string. More...
struct GNUNET_MY_QueryParam	GNUNET_MY_query_param_rsa_public_key (const struct GNUNET_CRYPTO_RsaPublicKey *x)
	Generate query parameter for an RSA public key. More...
struct GNUNET_MY_QueryParam	GNUNET_MY_query_param_rsa_signature (const struct GNUNET_CRYPTO_RsaSignature *x)
	Generate query parameter for an RSA signature. More...
struct GNUNET_MY_QueryParam	GNUNET_MY_query_param_absolute_time (const struct GNUNET_TIME_Absolute *x)
	Generate query parameter for an absolute time value. More...
struct GNUNET_MY_QueryParam	GNUNET_MY_query_param_absolute_time_nbo (const struct GNUNET_TIME_AbsoluteNBO *x)
	Generate query parameter for an absolute time value. More...
struct GNUNET_MY_QueryParam	GNUNET_MY_query_param_uint16 (const uint16_t *x)
	Generate query parameter for an uint16_t in host byte order. More...
struct GNUNET_MY_QueryParam	GNUNET_MY_query_param_uint32 (const uint32_t *x)
	Generate query parameter for an uint32_t in host byte order. More...
struct GNUNET_MY_QueryParam	GNUNET_MY_query_param_uint64 (const uint64_t *x)
	Generate query parameter for an uint64_t in host byte order. More...
struct GNUNET_MY_ResultSpec	GNUNET_MY_result_spec_variable_size (void **dst, size_t *ptr_size)
	Variable-size result expected. More...
struct GNUNET_MY_ResultSpec	GNUNET_MY_result_spec_rsa_public_key (struct GNUNET_CRYPTO_RsaPublicKey **rsa)
	RSA public key expected. More...
struct GNUNET_MY_ResultSpec	GNUNET_MY_result_spec_rsa_signature (struct GNUNET_CRYPTO_RsaSignature **sig)
	RSA signature expected. More...
struct GNUNET_MY_ResultSpec	GNUNET_MY_result_spec_string (char **dst)
	0- terminated string exprected. More...
struct GNUNET_MY_ResultSpec	GNUNET_MY_result_spec_absolute_time (struct GNUNET_TIME_Absolute *at)
	Absolute time expected. More...
struct GNUNET_MY_ResultSpec	GNUNET_MY_result_spec_absolute_time_nbo (struct GNUNET_TIME_AbsoluteNBO *at)
	Absolute time in network byte order expected. More...
struct GNUNET_MY_ResultSpec	GNUNET_MY_result_spec_uint16 (uint16_t *u16)
	uint16_t expected More...
struct GNUNET_MY_ResultSpec	GNUNET_MY_result_spec_uint32 (uint32_t *u32)
	uint32_t expected More...
struct GNUNET_MY_ResultSpec	GNUNET_MY_result_spec_uint64 (uint64_t *u64)
	uint64_t expected. More...
int	GNUNET_MY_extract_result (struct GNUNET_MYSQL_StatementHandle *sh, struct GNUNET_MY_ResultSpec *specs)
	Extract results from a query result according to the given specification. More...
void	GNUNET_MY_cleanup_query (struct GNUNET_MY_QueryParam *qp, MYSQL_BIND *qbind)
	Free all memory that was allocated in qp during #GNUNET_MY_exect_prepared(). More...
void	GNUNET_MY_cleanup_result (struct GNUNET_MY_ResultSpec *rs)
	Free all memory that was allocated in rs during GNUNET_MY_extract_result(). More...
struct GNUNET_MYSQL_Context *	GNUNET_MYSQL_context_create (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section)
	Create a mysql context. More...
void	GNUNET_MYSQL_context_destroy (struct GNUNET_MYSQL_Context *mc)
	Destroy a mysql context. More...
void	GNUNET_MYSQL_statements_invalidate (struct GNUNET_MYSQL_Context *mc)
	Close database connection and all prepared statements (we got a DB error). More...
MYSQL_STMT *	GNUNET_MYSQL_statement_get_stmt (struct GNUNET_MYSQL_StatementHandle *sh)
	Get internal handle for a prepared statement. More...
struct GNUNET_MYSQL_StatementHandle *	GNUNET_MYSQL_statement_prepare (struct GNUNET_MYSQL_Context *mc, const char *query)
	Prepare a statement. More...
int	GNUNET_MYSQL_statement_run (struct GNUNET_MYSQL_Context *mc, const char *sql)
	Run a SQL statement. More...

Detailed Description

Helper library to access a MySQL database.

Macro Definition Documentation

GNUNET_MY_query_param_end

#define GNUNET_MY_query_param_end   { NULL, NULL, NULL, 0, NULL, 0 }

End of query parameter specification.

Returns

array last entry for the result specification to use

Definition at line 130 of file gnunet_my_lib.h.

GNUNET_MY_result_spec_end

#define GNUNET_MY_result_spec_end   { NULL, NULL, NULL, 0, NULL, 0, 0 }

End of result speceter specification.

Returns

array last entry for the result specification to use

Definition at line 266 of file gnunet_my_lib.h.

GNUNET_MY_query_param_auto_from_type

#define GNUNET_MY_query_param_auto_from_type

(

x

)

GNUNET_MY_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 294 of file gnunet_my_lib.h.

GNUNET_MY_result_spec_auto_from_type

#define GNUNET_MY_result_spec_auto_from_type

(

dst

)

GNUNET_MY_result_spec_fixed_size ((dst), sizeof(*(dst)))

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

@spec name name of the field in the table @spec 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 371 of file gnunet_my_lib.h.

MYSQL_BOOL

#define MYSQL_BOOL   my_bool

Definition at line 46 of file gnunet_mysql_compat.h.

Typedef Documentation

GNUNET_MY_QueryConverter

typedef int(* GNUNET_MY_QueryConverter) (void *cls, const struct GNUNET_MY_QueryParam *qp, MYSQL_BIND *qbind)

Function called to convert input argument into SQL parameters.

Parameters

cls	closure
pq	data about the query
qbind	array of parameters to initialize

Returns

-1 on error

Definition at line 71 of file gnunet_my_lib.h.

GNUNET_MY_QueryCleanup

typedef void(* GNUNET_MY_QueryCleanup) (void *cls, MYSQL_BIND *qbind)

Function called to cleanup result data.

Parameters

cls	closure
rs	spec to clean up

Definition at line 83 of file gnunet_my_lib.h.

GNUNET_MY_ResultConverter

typedef int(* GNUNET_MY_ResultConverter) (void *cls, struct GNUNET_MY_ResultSpec *rs, MYSQL_STMT *stmt, unsigned int column, MYSQL_BIND *results)

Function called to convert input argument into SQL parameters.

Parameters

	cls	closure
[in,out]	rs
	stmt	the mysql statement that is being run
	column	the column that is being processed
[out]	results

Returns

-1 on error

Definition at line 181 of file gnunet_my_lib.h.

GNUNET_MY_ResultCleanup

typedef void(* GNUNET_MY_ResultCleanup) (void *cls, struct GNUNET_MY_ResultSpec *rs)

Function called to cleanup result data.

Parameters

cls	closure
rs	spec to clean up

Definition at line 194 of file gnunet_my_lib.h.

GNUNET_MYSQL_DataProcessor

typedef int(* GNUNET_MYSQL_DataProcessor) (void *cls, unsigned int num_values, MYSQL_BIND *values)

Type of a callback that will be called for each data set returned from MySQL.

Parameters

cls	user-defined argument
num_values	number of elements in values
values	values returned by MySQL

Returns

GNUNET_OK to continue iterating, GNUNET_SYSERR to abort

Definition at line 66 of file gnunet_mysql_lib.h.

Function Documentation

GNUNET_MY_query_param_fixed_size()

struct GNUNET_MY_QueryParam GNUNET_MY_query_param_fixed_size	(	const void *	ptr,
		size_t	ptr_size
	)

Generate query parameter for a buffer ptr of ptr_size bytes.FG.

Parameters

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

Generate query parameter for a buffer ptr of ptr_size bytes.FG.

Parameters

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

Definition at line 57 of file my_query_helper.c.

{
  struct GNUNET_MY_QueryParam qp = {
    .conv = &my_conv_fixed_size,
    .cleaner = NULL,
    .conv_cls = NULL,
    .num_params = 1,
    .data = ptr,
    .data_len = (unsigned long) ptr_size
  };
 
  return qp;
}

Referenced by mysql_plugin_put(), mysql_plugin_remove_key(), and regex_iterator().

Here is the caller graph for this function:

GNUNET_MY_exec_prepared()

int GNUNET_MY_exec_prepared	(	struct GNUNET_MYSQL_Context *	mc,
		struct GNUNET_MYSQL_StatementHandle *	sh,
		struct GNUNET_MY_QueryParam *	params
	)

Run a prepared SELECT statement.

Parameters

mc	mysql context
sh	handle to SELECT statement
params	parameters to the statement

Returns

TBD

Parameters

mc	mysql context
sh	handle to SELECT statement
params	parameters to the statement

Returns

GNUNET_YES if we can prepare all statement GNUNET_SYSERR if we can't prepare all statement

Definition at line 43 of file my.c.

{
  const struct GNUNET_MY_QueryParam *p;
  unsigned int num;
  MYSQL_STMT *stmt;
 
  num = 0;
  for (unsigned int i = 0; NULL != params[i].conv; i++)
    num += params[i].num_params;
  {
    MYSQL_BIND qbind[num];
    unsigned int off;
 
    memset (qbind,
            0,
            sizeof(qbind));
    off = 0;
    for (unsigned int i = 0; NULL != (p = &params[i])->conv; i++)
    {
      if (GNUNET_OK !=
          p->conv (p->conv_cls,
                   p,
                   &qbind[off]))
      {
        GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                    "Conversion for MySQL query failed at offset %u\n",
                    i);
        return GNUNET_SYSERR;
      }
      off += p->num_params;
    }
    stmt = GNUNET_MYSQL_statement_get_stmt (sh);
    if (mysql_stmt_bind_param (stmt,
                               qbind))
    {
      GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR,
                       "my",
                       _ ("`%s' failed at %s:%d with error: %s\n"),
                       "mysql_stmt_bind_param",
                       __FILE__, __LINE__,
                       mysql_stmt_error (stmt));
      GNUNET_MYSQL_statements_invalidate (mc);
      return GNUNET_SYSERR;
    }
 
    if (mysql_stmt_execute (stmt))
    {
      GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR,
                       "my",
                       _ ("`%s' failed at %s:%d with error: %s\n"),
                       "mysql_stmt_execute", __FILE__, __LINE__,
                       mysql_stmt_error (stmt));
      GNUNET_MYSQL_statements_invalidate (mc);
      return GNUNET_SYSERR;
    }
    GNUNET_MY_cleanup_query (params,
                             qbind);
  }
  return GNUNET_OK;
}

References _, conv, GNUNET_MY_QueryParam::conv, GNUNET_ERROR_TYPE_ERROR, GNUNET_log, GNUNET_log_from, GNUNET_MY_cleanup_query(), GNUNET_MYSQL_statement_get_stmt(), GNUNET_MYSQL_statements_invalidate(), GNUNET_OK, GNUNET_SYSERR, mc, GNUNET_MY_QueryParam::num_params, p, and sh.

Referenced by do_delete_entry(), execute_select(), mysql_plugin_estimate_size(), mysql_plugin_get_keys(), mysql_plugin_get_replication(), mysql_plugin_put(), mysql_plugin_remove_key(), regex_iterator(), and repl_proc().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_MY_result_spec_fixed_size()

struct GNUNET_MY_ResultSpec GNUNET_MY_result_spec_fixed_size	(	void *	ptr,
		size_t	ptr_size
	)

Obtain fixed size result of ptr_size bytes from MySQL, store in already allocated buffer at ptr.

@spec ptr where to write the result

Parameters

ptr_size

number of bytes available at ptr

Obtain fixed size result of ptr_size bytes from MySQL, store in already allocated buffer at ptr.

Parameters

	name	name of the field in the table
[out]	dst	where to store the result
	ptr_size	number of bytes in dst

Returns

array entry for the result specification to use

Definition at line 194 of file my_result_helper.c.

{
  struct GNUNET_MY_ResultSpec res = {
    .pre_conv = &pre_extract_fixed_blob,
    .post_conv = &post_extract_fixed_blob,
    .cleaner = NULL,
    .dst = (void *) (ptr),
    .dst_size = ptr_size,
    .num_fields = 1
  };
 
  return res;
}

References GNUNET_MY_ResultSpec::dst_size, GNUNET_OK, GNUNET_SYSERR, GNUNET_MY_ResultSpec::mysql_bind_output_length, and results.

GNUNET_MY_query_param_string()

struct GNUNET_MY_QueryParam GNUNET_MY_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 104 of file my_query_helper.c.

{
  struct GNUNET_MY_QueryParam qp = {
    .conv = &my_conv_string,
    .cleaner = NULL,
    .conv_cls = NULL,
    .num_params = 1,
    .data = ptr,
    .data_len = strlen (ptr)
  };
 
  return qp;
}

Referenced by regex_iterator().

Here is the caller graph for this function:

GNUNET_MY_query_param_rsa_public_key()

struct GNUNET_MY_QueryParam GNUNET_MY_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

Returns

array entry for the query parameters to use

Definition at line 279 of file my_query_helper.c.

{
  struct GNUNET_MY_QueryParam res = {
    .conv = &my_conv_rsa_public_key,
    .cleaner = &my_clean_query,
    .conv_cls = NULL,
    .num_params = 1,
    .data = x,
    .data_len = 0
  };
 
  return res;
}

GNUNET_MY_query_param_rsa_signature()

struct GNUNET_MY_QueryParam GNUNET_MY_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

Returns

array entry for the query parameters to use

Definition at line 331 of file my_query_helper.c.

{
  struct GNUNET_MY_QueryParam res = {
    .conv = &my_conv_rsa_signature,
    .cleaner = &my_clean_query,
    .conv_cls = NULL,
    .num_params = 1,
    .data = (x),
    .data_len = 0
  };
 
  return res;
}

GNUNET_MY_query_param_absolute_time()

struct GNUNET_MY_QueryParam GNUNET_MY_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

Returns

array entry for the query parameters to use

Definition at line 331 of file my_query_helper.c.

{
  return GNUNET_MY_query_param_uint64 (&x->abs_value_us);
}

Referenced by mysql_plugin_get_expiration().

Here is the caller graph for this function:

GNUNET_MY_query_param_absolute_time_nbo()

struct GNUNET_MY_QueryParam GNUNET_MY_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 331 of file my_query_helper.c.

{
  return GNUNET_MY_query_param_auto_from_type (&x->abs_value_us__);
}

GNUNET_MY_query_param_uint16()

struct GNUNET_MY_QueryParam GNUNET_MY_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 147 of file my_query_helper.c.

{
  struct GNUNET_MY_QueryParam res = {
    .conv = &my_conv_uint16,
    .cleaner = NULL,
    .conv_cls = NULL,
    .num_params = 1,
    .data = x,
    .data_len = sizeof(*x)
  };
 
  return res;
}

GNUNET_MY_query_param_uint32()

struct GNUNET_MY_QueryParam GNUNET_MY_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 191 of file my_query_helper.c.

{
  struct GNUNET_MY_QueryParam res = {
    .conv = &my_conv_uint32,
    .cleaner = NULL,
    .conv_cls = NULL,
    .num_params = 1,
    .data = x,
    .data_len = sizeof(*x)
  };
 
  return res;
}

Referenced by mysql_plugin_get_key(), mysql_plugin_get_replication(), mysql_plugin_get_zero_anonymity(), mysql_plugin_put(), and regex_iterator().

Here is the caller graph for this function:

GNUNET_MY_query_param_uint64()

struct GNUNET_MY_QueryParam GNUNET_MY_query_param_uint64

(

const uint64_t *

x

)

Generate query parameter for an uint64_t in host byte order.

Parameters

x	pointer to the query parameter to pass

Definition at line 235 of file my_query_helper.c.

{
  struct GNUNET_MY_QueryParam res = {
    .conv = &my_conv_uint64,
    .cleaner = NULL,
    .conv_cls = NULL,
    .num_params = 1,
    .data = x,
    .data_len = sizeof(*x)
  };
 
  return res;
}

Referenced by do_delete_entry(), mysql_plugin_get_key(), mysql_plugin_get_replication(), mysql_plugin_get_zero_anonymity(), mysql_plugin_put(), and repl_proc().

Here is the caller graph for this function:

GNUNET_MY_result_spec_variable_size()

struct GNUNET_MY_ResultSpec GNUNET_MY_result_spec_variable_size	(	void **	dst,
		size_t *	ptr_size
	)

Variable-size result expected.

Parameters

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

Returns

array entry for the result specification to use

Definition at line 120 of file my_result_helper.c.

{
  struct GNUNET_MY_ResultSpec res = {
    .pre_conv = &pre_extract_varsize_blob,
    .post_conv = &post_extract_varsize_blob,
    .cleaner = &cleanup_varsize_blob,
    .dst = (void *) (dst),
    .result_size = ptr_size,
    .num_fields = 1
  };
 
  return res;
}

Referenced by execute_select().

Here is the caller graph for this function:

GNUNET_MY_result_spec_rsa_public_key()

struct GNUNET_MY_ResultSpec GNUNET_MY_result_spec_rsa_public_key

(

struct GNUNET_CRYPTO_RsaPublicKey **

rsa

)

RSA public key expected.

Parameters

	name	name of the field in the table
[out]	rsa	where to store the result

Returns

array entry for the result specification to use

Definition at line 331 of file my_result_helper.c.

{
  struct GNUNET_MY_ResultSpec res = {
    .pre_conv = &pre_extract_rsa_public_key,
    .post_conv = &post_extract_rsa_public_key,
    .cleaner = &clean_rsa_public_key,
    .dst = (void *) rsa,
    .dst_size = 0,
    .num_fields = 1
  };
 
  return res;
}

GNUNET_MY_result_spec_rsa_signature()

struct GNUNET_MY_ResultSpec GNUNET_MY_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 462 of file my_result_helper.c.

{
  struct GNUNET_MY_ResultSpec res = {
    .pre_conv = &pre_extract_rsa_signature,
    .post_conv = &post_extract_rsa_signature,
    .cleaner = &clean_rsa_signature,
    .dst = (void *) sig,
    .dst_size = 0,
    .num_fields = 1
  };
 
  return res;
}

GNUNET_MY_result_spec_string()

struct GNUNET_MY_ResultSpec GNUNET_MY_result_spec_string

(

char **

dst

)

0- terminated string exprected.

Parameters

[out]

dst

where to store the result, allocated

Returns

array entry for the result specification to use

Definition at line 540 of file my_result_helper.c.

{
  struct GNUNET_MY_ResultSpec res = {
    .pre_conv = &pre_extract_string,
    .post_conv = &post_extract_string,
    .cleaner = NULL,
    .dst = (void *) dst,
    .dst_size = 0,
    .num_fields = 1
  };
 
  return res;
}

GNUNET_MY_result_spec_absolute_time()

struct GNUNET_MY_ResultSpec GNUNET_MY_result_spec_absolute_time

(

struct GNUNET_TIME_Absolute *

at

)

Absolute time expected.

Parameters

	name	name of the field in the table
[out]	at	where to store the result

Returns

array entry for the result specification to use

Definition at line 540 of file my_result_helper.c.

{
  return GNUNET_MY_result_spec_uint64 (&at->abs_value_us);
}

References buf, GNUNET_MY_ResultSpec::dst, GNUNET_free, GNUNET_malloc, GNUNET_OK, GNUNET_SYSERR, GNUNET_MY_ResultSpec::mysql_bind_output_length, results, and size.

Referenced by execute_select().

Here is the caller graph for this function:

GNUNET_MY_result_spec_absolute_time_nbo()

struct GNUNET_MY_ResultSpec GNUNET_MY_result_spec_absolute_time_nbo

(

struct GNUNET_TIME_AbsoluteNBO *

at

)

Absolute time in network byte order expected.

Parameters

[out]

at

where to store the result

Returns

array entry for the result specification to use

Definition at line 540 of file my_result_helper.c.

{
  struct GNUNET_MY_ResultSpec res =
    GNUNET_MY_result_spec_auto_from_type (&at->abs_value_us__);
 
  return res;
}

GNUNET_MY_result_spec_uint16()

struct GNUNET_MY_ResultSpec GNUNET_MY_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 672 of file my_result_helper.c.

{
  struct GNUNET_MY_ResultSpec res = {
    .pre_conv = &pre_extract_uint16,
    .post_conv = &post_extract_uint16,
    .cleaner = NULL,
    .dst = (void *) u16,
    .dst_size = sizeof(*u16),
    .num_fields = 1
  };
 
  return res;
}

References GNUNET_MY_ResultSpec::dst_size, GNUNET_OK, GNUNET_SYSERR, GNUNET_MY_ResultSpec::mysql_bind_output_length, and results.

GNUNET_MY_result_spec_uint32()

struct GNUNET_MY_ResultSpec GNUNET_MY_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 751 of file my_result_helper.c.

{
  struct GNUNET_MY_ResultSpec res = {
    .pre_conv = &pre_extract_uint32,
    .post_conv = &post_extract_uint32,
    .cleaner = NULL,
    .dst = (void *) u32,
    .dst_size = sizeof(*u32),
    .num_fields = 1
  };
 
  return res;
}

References GNUNET_MY_ResultSpec::dst_size, GNUNET_OK, GNUNET_SYSERR, GNUNET_MY_ResultSpec::mysql_bind_output_length, and results.

Referenced by execute_select(), and mysql_plugin_get_replication().

Here is the caller graph for this function:

GNUNET_MY_result_spec_uint64()

struct GNUNET_MY_ResultSpec GNUNET_MY_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 832 of file my_result_helper.c.

{
  struct GNUNET_MY_ResultSpec res = {
    .pre_conv = &pre_extract_uint64,
    .post_conv = &post_extract_uint64,
    .cleaner = NULL,
    .dst = (void *) u64,
    .dst_size = sizeof(*u64),
    .num_fields = 1
  };
 
  return res;
}

References GNUNET_MY_ResultSpec::dst_size, GNUNET_OK, GNUNET_SYSERR, and results.

Referenced by execute_select(), mysql_plugin_estimate_size(), and regex_iterator().

Here is the caller graph for this function:

GNUNET_MY_extract_result()

int GNUNET_MY_extract_result	(	struct GNUNET_MYSQL_StatementHandle *	sh,
		struct GNUNET_MY_ResultSpec *	rs
	)

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

Always fetches the next row.

Parameters

sh	statement that returned results
rs	specification to extract for

Returns

GNUNET_YES if all results could be extracted GNUNET_NO if there is no more data in the result set GNUNET_SYSERR if a result was invalid

Definition at line 137 of file my.c.

{
  unsigned int num_fields;
  int ret;
  MYSQL_STMT *stmt;
 
  stmt = GNUNET_MYSQL_statement_get_stmt (sh);
  if (NULL == stmt)
  {
    GNUNET_break (0);
    return GNUNET_SYSERR;
  }
  if (NULL == rs)
  {
    mysql_stmt_free_result (stmt);
    return GNUNET_NO;
  }
 
  num_fields = 0;
  for (unsigned int i = 0; NULL != rs[i].pre_conv; i++)
    num_fields += rs[i].num_fields;
 
  if (mysql_stmt_field_count (stmt) != num_fields)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Number of fields mismatch between SQL result and result specification\n");
    return GNUNET_SYSERR;
  }
 
  {
    MYSQL_BIND result[num_fields];
    unsigned int field_off;
 
    memset (result, 0, sizeof(MYSQL_BIND) * num_fields);
    field_off = 0;
    for (unsigned int i = 0; NULL != rs[i].pre_conv; i++)
    {
      struct GNUNET_MY_ResultSpec *rp = &rs[i];
 
      if (GNUNET_OK !=
          rp->pre_conv (rp->conv_cls,
                        rp,
                        stmt,
                        field_off,
                        &result[field_off]))
 
      {
        GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                    "Pre-conversion for MySQL result failed at offset %u\n",
                    i);
        return GNUNET_SYSERR;
      }
      field_off += rp->num_fields;
    }
 
    if (mysql_stmt_bind_result (stmt, result))
    {
      GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR,
                       "my",
                       _ ("%s failed at %s:%d with error: %s\n"),
                       "mysql_stmt_bind_result",
                       __FILE__, __LINE__,
                       mysql_stmt_error (stmt));
      return GNUNET_SYSERR;
    }
#if TEST_OPTIMIZATION
    (void) mysql_stmt_store_result (stmt);
#endif
    ret = mysql_stmt_fetch (stmt);
    if (MYSQL_NO_DATA == ret)
    {
      mysql_stmt_free_result (stmt);
      return GNUNET_NO;
    }
    if (1 == ret)
    {
      GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR,
                       "my",
                       _ ("%s failed at %s:%d with error: %s\n"),
                       "mysql_stmt_fetch",
                       __FILE__, __LINE__,
                       mysql_stmt_error (stmt));
      GNUNET_MY_cleanup_result (rs);
      mysql_stmt_free_result (stmt);
      return GNUNET_SYSERR;
    }
    field_off = 0;
    for (unsigned int i = 0; NULL != rs[i].post_conv; i++)
    {
      struct GNUNET_MY_ResultSpec *rp = &rs[i];
 
      if (NULL != rp->post_conv)
        if (GNUNET_OK !=
            rp->post_conv (rp->conv_cls,
                           rp,
                           stmt,
                           field_off,
                           &result[field_off]))
        {
          GNUNET_log (GNUNET_ERROR_TYPE_INFO,
                      "Post-conversion for MySQL result failed at offset %u\n",
                      i);
          mysql_stmt_free_result (stmt);
          for (unsigned int j = 0; j < i; j++)
            if (NULL != rs[j].cleaner)
              rs[j].cleaner (rs[j].conv_cls,
                             rs[j].dst);
          return GNUNET_SYSERR;
        }
      field_off += rp->num_fields;
    }
  }
  return GNUNET_OK;
}

References _, GNUNET_MY_ResultSpec::cleaner, GNUNET_MY_ResultSpec::conv_cls, GNUNET_MY_ResultSpec::dst, GNUNET_break, GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_INFO, GNUNET_log, GNUNET_log_from, GNUNET_MY_cleanup_result(), GNUNET_MYSQL_statement_get_stmt(), GNUNET_NO, GNUNET_OK, GNUNET_SYSERR, GNUNET_MY_ResultSpec::post_conv, GNUNET_MY_ResultSpec::pre_conv, result, ret, rp, and sh.

Referenced by execute_select(), mysql_plugin_estimate_size(), mysql_plugin_get_keys(), mysql_plugin_get_replication(), mysql_plugin_put(), and regex_iterator().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_MY_cleanup_query()

void GNUNET_MY_cleanup_query	(	struct GNUNET_MY_QueryParam *	qp,
		MYSQL_BIND *	qbind
	)

Free all memory that was allocated in qp during #GNUNET_MY_exect_prepared().

Parameters

qp	query specification to clean up
qbind	mysql query

Free all memory that was allocated in qp during #GNUNET_MY_exect_prepared().

Parameters

qp	query specification to clean up
qbind	array of parameter to clean up

Definition at line 115 of file my.c.

{
  for (unsigned int i = 0; NULL != qp[i].conv; i++)
    if (NULL != qp[i].cleaner)
      qp[i].cleaner (qp[i].conv_cls,
                     &qbind[i]);
}

References GNUNET_MY_QueryParam::cleaner, GNUNET_MY_QueryParam::conv, and GNUNET_MY_QueryParam::conv_cls.

Referenced by GNUNET_MY_exec_prepared().

Here is the caller graph for this function:

GNUNET_MY_cleanup_result()

void GNUNET_MY_cleanup_result

(

struct GNUNET_MY_ResultSpec *

rs

)

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

Parameters

rs	reult specification to clean up
rs	result specification to clean up

Definition at line 261 of file my.c.

{
  for (unsigned int i = 0; NULL != rs[i].post_conv; i++)
    if (NULL != rs[i].cleaner)
      rs[i].cleaner (rs[i].conv_cls,
                     &rs[i]);
}

References GNUNET_MY_ResultSpec::cleaner, GNUNET_MY_ResultSpec::conv_cls, and GNUNET_MY_ResultSpec::post_conv.

Referenced by execute_select(), and GNUNET_MY_extract_result().

Here is the caller graph for this function:

GNUNET_MYSQL_context_create()

struct GNUNET_MYSQL_Context* GNUNET_MYSQL_context_create	(	const struct GNUNET_CONFIGURATION_Handle *	cfg,
		const char *	section
	)

Create a mysql context.

Parameters

cfg	configuration
section	configuration section to use to get MySQL configuration options

Returns

the mysql context

Definition at line 321 of file mysql.c.

{
  struct GNUNET_MYSQL_Context *mc;
 
  mc = GNUNET_new (struct GNUNET_MYSQL_Context);
  mc->cfg = cfg;
  mc->section = section;
  mc->cnffile = get_my_cnf_path (cfg, section);
 
  return mc;
}

References cfg, GNUNET_TESTBED_Controller::cfg, get_my_cnf_path(), GNUNET_new, mc, and GNUNET_MYSQL_Context::section.

Referenced by libgnunet_plugin_datastore_mysql_init(), and run().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_MYSQL_context_destroy()

void GNUNET_MYSQL_context_destroy

(

struct GNUNET_MYSQL_Context *

mc

)

Destroy a mysql context.

Also frees all associated prepared statements.

Parameters

mc	context to destroy

Definition at line 369 of file mysql.c.

{
  struct GNUNET_MYSQL_StatementHandle *sh;
 
  GNUNET_MYSQL_statements_invalidate (mc);
  while (NULL != (sh = mc->shead))
  {
    GNUNET_CONTAINER_DLL_remove (mc->shead, mc->stail, sh);
    GNUNET_free (sh->query);
    GNUNET_free (sh);
  }
  GNUNET_free (mc);
  mysql_library_end ();
}

References GNUNET_CONTAINER_DLL_remove, GNUNET_free, GNUNET_MYSQL_statements_invalidate(), mc, and sh.

Referenced by do_shutdown(), libgnunet_plugin_datastore_mysql_done(), and libgnunet_plugin_datastore_mysql_init().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_MYSQL_statements_invalidate()

void GNUNET_MYSQL_statements_invalidate

(

struct GNUNET_MYSQL_Context *

mc

)

Close database connection and all prepared statements (we got a DB error).

The connection will automatically be re-opened and statements will be re-prepared if they are needed again later.

Parameters

mc	mysql context
mc	mysql context

Definition at line 342 of file mysql.c.

{
  struct GNUNET_MYSQL_StatementHandle *sh;
 
  for (sh = mc->shead; NULL != sh; sh = sh->next)
  {
    if (GNUNET_YES == sh->valid)
    {
      mysql_stmt_close (sh->statement);
      sh->valid = GNUNET_NO;
    }
    sh->statement = NULL;
  }
  if (NULL != mc->dbf)
  {
    mysql_close (mc->dbf);
    mc->dbf = NULL;
  }
}

References GNUNET_NO, GNUNET_YES, mc, and sh.

Referenced by GNUNET_MY_exec_prepared(), GNUNET_MYSQL_context_destroy(), GNUNET_MYSQL_statement_run(), mysql_plugin_get_keys(), and prepare_statement().

Here is the caller graph for this function:

GNUNET_MYSQL_statement_get_stmt()

MYSQL_STMT* GNUNET_MYSQL_statement_get_stmt

(

struct GNUNET_MYSQL_StatementHandle *

sh

)

Get internal handle for a prepared statement.

This function should rarely be used, and if, with caution! On failures during the interaction with the handle, you must call GNUNET_MYSQL_statements_invalidate()!

Parameters

sh	prepared statement to introspect

Returns

MySQL statement handle, NULL on error

This function should rarely be used, and if, with caution! On failures during the interaction with the handle, you must call 'GNUNET_MYSQL_statements_invalidate'!

Parameters

sh	prepared statement to introspect

Returns

MySQL statement handle, NULL on error

Definition at line 478 of file mysql.c.

{
  (void) prepare_statement (sh);
  return sh->statement;
}

References prepare_statement(), and sh.

Referenced by GNUNET_MY_exec_prepared(), GNUNET_MY_extract_result(), mysql_plugin_get_keys(), mysql_plugin_put(), and mysql_plugin_remove_key().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_MYSQL_statement_prepare()

struct GNUNET_MYSQL_StatementHandle* GNUNET_MYSQL_statement_prepare	(	struct GNUNET_MYSQL_Context *	mc,
		const char *	query
	)

Prepare a statement.

Prepared statements are automatically discarded when the MySQL context is destroyed.

Parameters

mc	mysql context
query	query text

Returns

prepared statement, NULL on error

Definition at line 394 of file mysql.c.

{
  struct GNUNET_MYSQL_StatementHandle *sh;
 
  sh = GNUNET_new (struct GNUNET_MYSQL_StatementHandle);
  sh->mc = mc;
  sh->query = GNUNET_strdup (query);
  GNUNET_CONTAINER_DLL_insert (mc->shead, mc->stail, sh);
  return sh;
}

References GNUNET_CONTAINER_DLL_insert, GNUNET_new, GNUNET_strdup, mc, GNUNET_MYSQL_StatementHandle::query, and sh.

Referenced by do_directory_scan().

Here is the caller graph for this function:

GNUNET_MYSQL_statement_run()

int GNUNET_MYSQL_statement_run	(	struct GNUNET_MYSQL_Context *	mc,
		const char *	sql
	)

Run a SQL statement.

Parameters

mc	mysql context
sql	SQL statement to run

Returns

GNUNET_OK on success GNUNET_SYSERR if there was a problem

Definition at line 416 of file mysql.c.

{
  if ((NULL == mc->dbf) && (GNUNET_OK != iopen (mc)))
    return GNUNET_SYSERR;
  mysql_query (mc->dbf, sql);
  if (mysql_error (mc->dbf)[0])
  {
    LOG_MYSQL (GNUNET_ERROR_TYPE_ERROR, "mysql_query", mc);
    GNUNET_MYSQL_statements_invalidate (mc);
    return GNUNET_SYSERR;
  }
  return GNUNET_OK;
}

References GNUNET_ERROR_TYPE_ERROR, GNUNET_MYSQL_statements_invalidate(), GNUNET_OK, GNUNET_SYSERR, iopen(), LOG_MYSQL, and mc.

Referenced by mysql_plugin_drop().

Here is the call graph for this function:

Here is the caller graph for this function: