plugin_namecache_postgres.c File Reference

postgres-based namecache backend More...

#include "platform.h"
#include "gnunet_namecache_plugin.h"
#include "gnunet_gnsrecord_lib.h"
#include "gnunet_pq_lib.h"

Include dependency graph for plugin_namecache_postgres.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, "namecache-postgres", __VA_ARGS__)

Functions
static void	reconnect_setup (void *cls, struct GNUNET_PQ_Context *pq)
	Function called whenever we reconnect to the DB.
static enum GNUNET_GenericReturnValue	database_setup (struct Plugin *plugin)
	Initialize the database connections and associated data structures (create tables and indices as needed as well).
static void	namecache_postgres_expire_blocks (struct Plugin *plugin)
	Removes any expired block.
static void	delete_old_block (struct Plugin *plugin, const struct GNUNET_HashCode *query, struct GNUNET_TIME_Absolute expiration_time)
	Delete older block in the datastore.
static enum GNUNET_GenericReturnValue	namecache_postgres_cache_block (void *cls, const struct GNUNET_GNSRECORD_Block *block)
	Cache a block in the datastore.
static enum GNUNET_GenericReturnValue	namecache_postgres_del_block (void *cls, const struct GNUNET_HashCode *query)
	Remove the block for a particular zone and label from the datastore.
static enum GNUNET_GenericReturnValue	namecache_postgres_lookup_block (void *cls, const struct GNUNET_HashCode *query, GNUNET_NAMECACHE_BlockCallback iter, void *iter_cls)
	Get the block for a particular zone and label in the datastore.
static void	database_shutdown (struct Plugin *plugin)
	Shutdown database connection and associate data structures.
void *	libgnunet_plugin_namecache_postgres_init (void *cls)
	Entry point for the plugin.
void *	libgnunet_plugin_namecache_postgres_done (void *cls)
	Exit point from the plugin.

Detailed Description

postgres-based namecache backend

Author

Christian Grothoff

Definition in file plugin_namecache_postgres.c.

Macro Definition Documentation

LOG

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

Definition at line 32 of file plugin_namecache_postgres.c.

Function Documentation

reconnect_setup()

static void reconnect_setup ( void *  cls, struct GNUNET_PQ_Context *  pq  )

static

Function called whenever we reconnect to the DB.

Sets up the options, possibly the tables and the prepared statements.

Parameters

cls	the struct Plugin
pq	database handle

Definition at line 62 of file plugin_namecache_postgres.c.

{
  struct Plugin *plugin = cls;
  struct GNUNET_PQ_PreparedStatement ps[] = {
    GNUNET_PQ_make_prepare ("cache_block",
                            "INSERT INTO namecache.ns096blocks"
                            " (query, block, expiration_time)"
                            " VALUES"
                            " ($1, $2, $3)"),
    GNUNET_PQ_make_prepare ("expire_blocks",
                            "DELETE FROM namecache.ns096blocks"
                            " WHERE expiration_time<$1"),
    GNUNET_PQ_make_prepare ("delete_block",
                            "DELETE FROM namecache.ns096blocks"
                            " WHERE query=$1 AND expiration_time<=$2"),
    GNUNET_PQ_make_prepare ("purge_block",
                            "DELETE FROM namecache.ns096blocks"
                            " WHERE query=$1"),
    GNUNET_PQ_make_prepare ("lookup_block",
                            "SELECT block"
                            " FROM namecache.ns096blocks"
                            " WHERE query=$1"
                            " ORDER BY expiration_time DESC LIMIT 1"),
    GNUNET_PQ_PREPARED_STATEMENT_END
  };
 
  if (GNUNET_SYSERR ==
      GNUNET_PQ_load_versioning (pq))
  {
    plugin->ready = false;
    return;
  }
  if (GNUNET_OK !=
      GNUNET_PQ_run_sql (pq,
                         "namecache-"))
  {
    plugin->ready = false;
    return;
  }
  if (GNUNET_OK !=
      GNUNET_PQ_prepare_statements (pq,
                                    ps))
  {
    plugin->ready = false;
    return;
  }
  plugin->ready = true;
}

References GNUNET_OK, GNUNET_PQ_load_versioning(), GNUNET_PQ_make_prepare(), GNUNET_PQ_prepare_statements(), GNUNET_PQ_PREPARED_STATEMENT_END, GNUNET_PQ_run_sql(), GNUNET_SYSERR, plugin, and ps.

Referenced by database_setup().

Here is the call graph for this function:

Here is the caller graph for this function:

database_setup()

static enum GNUNET_GenericReturnValue database_setup ( struct Plugin *  plugin )

static

Initialize the database connections and associated data structures (create tables and indices as needed as well).

Parameters

plugin

the plugin context (state for this module)

Returns

GNUNET_OK on success

Definition at line 122 of file plugin_namecache_postgres.c.

{
  plugin->dbh = GNUNET_PQ_init (plugin->cfg,
                                "namecache-postgres",
                                &reconnect_setup,
                                plugin);
  if (NULL == plugin->dbh)
    return GNUNET_SYSERR;
  if (! plugin->ready)
    return GNUNET_NO;
  return GNUNET_OK;
}

References GNUNET_NO, GNUNET_OK, GNUNET_PQ_init(), GNUNET_SYSERR, plugin, and reconnect_setup().

Referenced by libgnunet_plugin_namecache_postgres_init().

Here is the call graph for this function:

Here is the caller graph for this function:

namecache_postgres_expire_blocks()

static void namecache_postgres_expire_blocks ( struct Plugin *  plugin )

static

Removes any expired block.

Parameters

plugin

the plugin

Definition at line 142 of file plugin_namecache_postgres.c.

{
  struct GNUNET_TIME_Absolute now = GNUNET_TIME_absolute_get ();
  struct GNUNET_PQ_QueryParam params[] = {
    GNUNET_PQ_query_param_absolute_time (&now),
    GNUNET_PQ_query_param_end
  };
  enum GNUNET_DB_QueryStatus res;
 
  res = GNUNET_PQ_eval_prepared_non_select (plugin->dbh,
                                            "expire_blocks",
                                            params);
  GNUNET_break (GNUNET_DB_STATUS_HARD_ERROR != res);
}

References GNUNET_break, GNUNET_DB_STATUS_HARD_ERROR, GNUNET_PQ_eval_prepared_non_select(), GNUNET_PQ_query_param_absolute_time(), GNUNET_PQ_query_param_end, GNUNET_TIME_absolute_get(), plugin, and res.

Referenced by namecache_postgres_cache_block().

Here is the call graph for this function:

Here is the caller graph for this function:

delete_old_block()

static void delete_old_block ( struct Plugin *  plugin, const struct GNUNET_HashCode *  query, struct GNUNET_TIME_Absolute  expiration_time  )

static

Delete older block in the datastore.

Parameters

plugin	the plugin
query	query for the block
expiration_time	how old does the block have to be for deletion

Definition at line 166 of file plugin_namecache_postgres.c.

{
  struct GNUNET_PQ_QueryParam params[] = {
    GNUNET_PQ_query_param_auto_from_type (query),
    GNUNET_PQ_query_param_absolute_time (&expiration_time),
    GNUNET_PQ_query_param_end
  };
  enum GNUNET_DB_QueryStatus res;
 
  res = GNUNET_PQ_eval_prepared_non_select (plugin->dbh,
                                            "delete_block",
                                            params);
  GNUNET_break (GNUNET_DB_STATUS_HARD_ERROR != res);
}

References GNUNET_break, GNUNET_DB_STATUS_HARD_ERROR, GNUNET_PQ_eval_prepared_non_select(), GNUNET_PQ_query_param_absolute_time(), GNUNET_PQ_query_param_auto_from_type, GNUNET_PQ_query_param_end, plugin, and res.

Referenced by namecache_postgres_cache_block().

Here is the call graph for this function:

Here is the caller graph for this function:

namecache_postgres_cache_block()

static enum GNUNET_GenericReturnValue namecache_postgres_cache_block ( void *  cls, const struct GNUNET_GNSRECORD_Block *  block  )

static

Cache a block in the datastore.

Parameters

cls	closure (internal context for the plugin)
block	block to cache

Returns

GNUNET_OK on success, else GNUNET_SYSERR

Definition at line 192 of file plugin_namecache_postgres.c.

{
  struct Plugin *plugin = cls;
  struct GNUNET_HashCode query;
  size_t block_size = GNUNET_GNSRECORD_block_get_size (block);
  struct GNUNET_TIME_Absolute exp = GNUNET_GNSRECORD_block_get_expiration (block
                                                                           );
  enum GNUNET_DB_QueryStatus res;
 
  namecache_postgres_expire_blocks (plugin);
  GNUNET_GNSRECORD_query_from_block (block,
                                     &query);
  if (block_size > 64 * 65536)
  {
    GNUNET_break (0);
    return GNUNET_SYSERR;
  }
  {
    struct GNUNET_PQ_QueryParam params[] = {
      GNUNET_PQ_query_param_auto_from_type (&query),
      GNUNET_PQ_query_param_fixed_size (block, block_size),
      GNUNET_PQ_query_param_absolute_time (&exp),
      GNUNET_PQ_query_param_end
    };
    delete_old_block (plugin,
                      &query,
                      exp);
 
    res = GNUNET_PQ_eval_prepared_non_select (plugin->dbh,
                                              "cache_block",
                                              params);
  }
  if (0 > res)
    return GNUNET_SYSERR;
  return GNUNET_OK;
}

References delete_old_block(), GNUNET_break, GNUNET_GNSRECORD_block_get_expiration(), GNUNET_GNSRECORD_block_get_size(), GNUNET_GNSRECORD_query_from_block(), GNUNET_OK, GNUNET_PQ_eval_prepared_non_select(), GNUNET_PQ_query_param_absolute_time(), GNUNET_PQ_query_param_auto_from_type, GNUNET_PQ_query_param_end, GNUNET_PQ_query_param_fixed_size(), GNUNET_SYSERR, namecache_postgres_expire_blocks(), plugin, and res.

Referenced by libgnunet_plugin_namecache_postgres_init().

Here is the call graph for this function:

Here is the caller graph for this function:

namecache_postgres_del_block()

static enum GNUNET_GenericReturnValue namecache_postgres_del_block ( void *  cls, const struct GNUNET_HashCode *  query  )

static

Remove the block for a particular zone and label from the datastore.

Parameters

cls	closure (internal context for the plugin)
query	hash of public key derived from the zone and the label

Returns

GNUNET_OK on success, GNUNET_NO if there was no such block, GNUNET_SYSERR on error

Definition at line 241 of file plugin_namecache_postgres.c.

{
  struct Plugin *plugin = cls;
  struct GNUNET_PQ_QueryParam params[] = {
    GNUNET_PQ_query_param_auto_from_type (query),
    GNUNET_PQ_query_param_end
  };
  enum GNUNET_DB_QueryStatus res;
 
  res = GNUNET_PQ_eval_prepared_non_select (plugin->dbh,
                                            "purge_block",
                                            params);
  if (GNUNET_DB_STATUS_SUCCESS_NO_RESULTS == res)
    return GNUNET_NO;
  if (0 > res)
    return GNUNET_SYSERR;
  return GNUNET_OK;
}

References GNUNET_DB_STATUS_SUCCESS_NO_RESULTS, GNUNET_NO, GNUNET_OK, GNUNET_PQ_eval_prepared_non_select(), GNUNET_PQ_query_param_auto_from_type, GNUNET_PQ_query_param_end, GNUNET_SYSERR, plugin, and res.

Referenced by libgnunet_plugin_namecache_postgres_init().

Here is the call graph for this function:

Here is the caller graph for this function:

namecache_postgres_lookup_block()

static enum GNUNET_GenericReturnValue namecache_postgres_lookup_block ( void *  cls, const struct GNUNET_HashCode *  query, GNUNET_NAMECACHE_BlockCallback  iter, void *  iter_cls  )

static

Get the block for a particular zone and label in the datastore.

Will return at most one result to the iterator.

Parameters

cls	closure (internal context for the plugin)
query	hash of public key derived from the zone and the label
iter	function to call with the result
iter_cls	closure for iter

Returns

GNUNET_OK on success, GNUNET_NO if there were no results, GNUNET_SYSERR on error

Definition at line 273 of file plugin_namecache_postgres.c.

{
  struct Plugin *plugin = cls;
  size_t bsize;
  struct GNUNET_GNSRECORD_Block *block;
  struct GNUNET_PQ_QueryParam params[] = {
    GNUNET_PQ_query_param_auto_from_type (query),
    GNUNET_PQ_query_param_end
  };
  struct GNUNET_PQ_ResultSpec rs[] = {
    GNUNET_PQ_result_spec_variable_size ("block",
                                         (void **) &block,
                                         &bsize),
    GNUNET_PQ_result_spec_end
  };
  enum GNUNET_DB_QueryStatus res;
 
  res = GNUNET_PQ_eval_prepared_singleton_select (plugin->dbh,
                                                  "lookup_block",
                                                  params,
                                                  rs);
  if (0 > res)
  {
    LOG (GNUNET_ERROR_TYPE_WARNING,
         "Failing lookup block in namecache (postgres error)\n");
    return GNUNET_SYSERR;
  }
  if (GNUNET_DB_STATUS_SUCCESS_NO_RESULTS == res)
  {
    /* no result */
    LOG (GNUNET_ERROR_TYPE_DEBUG,
         "Ending iteration (no more results)\n");
    return GNUNET_NO;
  }
  if ((bsize < sizeof(*block)))
  {
    GNUNET_break (0);
    LOG (GNUNET_ERROR_TYPE_DEBUG,
         "Failing lookup (corrupt block)\n");
    GNUNET_PQ_cleanup_result (rs);
    return GNUNET_SYSERR;
  }
  iter (iter_cls,
        block);
  GNUNET_PQ_cleanup_result (rs);
  return GNUNET_OK;
}

References bsize, GNUNET_break, GNUNET_DB_STATUS_SUCCESS_NO_RESULTS, GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_WARNING, GNUNET_NO, GNUNET_OK, GNUNET_PQ_cleanup_result(), GNUNET_PQ_eval_prepared_singleton_select(), GNUNET_PQ_query_param_auto_from_type, GNUNET_PQ_query_param_end, GNUNET_PQ_result_spec_end, GNUNET_PQ_result_spec_variable_size(), GNUNET_SYSERR, LOG, plugin, and res.

Referenced by libgnunet_plugin_namecache_postgres_init().

Here is the call graph for this function:

Here is the caller graph for this function:

database_shutdown()

static void database_shutdown ( struct Plugin *  plugin )

static

Shutdown database connection and associate data structures.

Parameters

plugin

the plugin context (state for this module)

Definition at line 332 of file plugin_namecache_postgres.c.

{
  GNUNET_PQ_disconnect (plugin->dbh);
  plugin->dbh = NULL;
}

References GNUNET_PQ_disconnect(), and plugin.

Referenced by libgnunet_plugin_namecache_postgres_done(), and libgnunet_plugin_namecache_postgres_init().

Here is the call graph for this function:

Here is the caller graph for this function:

libgnunet_plugin_namecache_postgres_init()

void * libgnunet_plugin_namecache_postgres_init

(

void *

cls

)

Entry point for the plugin.

Parameters

cls	the struct GNUNET_NAMECACHE_PluginEnvironment *

Returns

NULL on error, otherwise the plugin context

Definition at line 349 of file plugin_namecache_postgres.c.

{
  static struct Plugin plugin;
  const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
  struct GNUNET_NAMECACHE_PluginFunctions *api;
 
  if (NULL != plugin.cfg)
    return NULL;                /* can only initialize once! */
  memset (&plugin,
          0,
          sizeof(struct Plugin));
  plugin.cfg = cfg;
  if (GNUNET_OK !=
      database_setup (&plugin))
  {
    database_shutdown (&plugin);
    return NULL;
  }
  api = GNUNET_new (struct GNUNET_NAMECACHE_PluginFunctions);
  api->cls = &plugin;
  api->cache_block = &namecache_postgres_cache_block;
  api->lookup_block = &namecache_postgres_lookup_block;
  api->del_block = &namecache_postgres_del_block;
  LOG (GNUNET_ERROR_TYPE_INFO,
       "Postgres namecache plugin running\n");
  return api;
}

References GNUNET_NAMECACHE_PluginFunctions::cache_block, cfg, GNUNET_NAMECACHE_PluginFunctions::cls, database_setup(), database_shutdown(), GNUNET_NAMECACHE_PluginFunctions::del_block, GNUNET_ERROR_TYPE_INFO, GNUNET_new, GNUNET_OK, LOG, GNUNET_NAMECACHE_PluginFunctions::lookup_block, namecache_postgres_cache_block(), namecache_postgres_del_block(), namecache_postgres_lookup_block(), and plugin.

Here is the call graph for this function:

libgnunet_plugin_namecache_postgres_done()

void * libgnunet_plugin_namecache_postgres_done

(

void *

cls

)

Exit point from the plugin.

Parameters

cls	the plugin context (as returned by "init")

Returns

always NULL

Definition at line 388 of file plugin_namecache_postgres.c.

{
  struct GNUNET_NAMECACHE_PluginFunctions *api = cls;
  struct Plugin *plugin = api->cls;
 
  database_shutdown (plugin);
  plugin->cfg = NULL;
  GNUNET_free (api);
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "Postgres namecache plugin is finished\n");
  return NULL;
}

References Plugin::api, GNUNET_BLOCK_PluginFunctions::cls, GNUNET_NAMECACHE_PluginFunctions::cls, database_shutdown(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, LOG, and plugin.

Here is the call graph for this function: