rlm_cache_memcached.c File Reference

memcached based cache. More...

#include <libmemcached/memcached.h>
#include <freeradius-devel/server/base.h>
#include <freeradius-devel/server/module_rlm.h>
#include <freeradius-devel/util/debug.h>
#include <freeradius-devel/util/slab.h>
#include <freeradius-devel/util/value.h>
#include "../../rlm_cache.h"
#include "../../serialize.h"

Include dependency graph for rlm_cache_memcached.c:

Go to the source code of this file.

Data Structures
struct	rlm_cache_memcached_handle_t
struct	rlm_cache_memcached_t
struct	rlm_cache_memcached_thread_t

Macros
#define	LOG_PREFIX   "cache - memcached"

Functions
static int	_mod_conn_free (rlm_cache_memcached_handle_t *mandle)
	Free a connection handle.
static cache_status_t	cache_entry_expire (UNUSED rlm_cache_config_t const *config, UNUSED void *instance, request_t *request, void *handle, fr_value_box_t const *key)
	Call delete the cache entry from memcached.
static cache_status_t	cache_entry_find (rlm_cache_entry_t **out, UNUSED rlm_cache_config_t const *config, UNUSED void *instance, request_t *request, void *handle, fr_value_box_t const *key)
	Locate a cache entry in memcached.
static void	cache_entry_free (rlm_cache_entry_t *c)
	Locate a cache entry in memcached.
static cache_status_t	cache_entry_insert (UNUSED rlm_cache_config_t const *config, UNUSED void *instance, request_t *request, void *handle, const rlm_cache_entry_t *c)
	Insert a new entry into the data store.
static int	memcached_conn_init (rlm_cache_memcached_handle_t *mandle, void *uctx)
	Create a new memcached handle.
static int	mod_conn_get (void **handle, UNUSED rlm_cache_config_t const *config, void *instance, UNUSED request_t *request)
	Get a memcached handle.
static int	mod_conn_reconnect (void **handle, UNUSED rlm_cache_config_t const *config, void *instance, UNUSED request_t *request)
	Reconnect a memcached handle.
static void	mod_conn_release (UNUSED rlm_cache_config_t const *config, UNUSED void *instance, UNUSED request_t *request, rlm_cache_handle_t *handle)
	Release a memcached handle.
static int	mod_instantiate (module_inst_ctx_t const *mctx)
	Create a new rlm_cache_memcached instance.
static int	mod_load (void)
static int	mod_thread_detach (module_thread_inst_ctx_t const *mctx)
static int	mod_thread_instantiate (module_thread_inst_ctx_t const *mctx)

Variables
static const conf_parser_t	driver_config []
static conf_parser_t	reuse_memcached_config []
rlm_cache_driver_t	rlm_cache_memcached

Detailed Description

memcached based cache.

Id

52014aa5d13ea18b7e22a023a1ba31181d4933ec

Copyright

2014 The FreeRADIUS server project

Definition in file rlm_cache_memcached.c.

---

Data Structure Documentation

rlm_cache_memcached_handle_t

struct rlm_cache_memcached_handle_t

Definition at line 38 of file rlm_cache_memcached.c.

Data Fields
memcached_st *	handle

rlm_cache_memcached_t

struct rlm_cache_memcached_t

Definition at line 45 of file rlm_cache_memcached.c.

Collaboration diagram for rlm_cache_memcached_t:

Data Fields
module_instance_t const *	mi
char const *	options	Connection options.
fr_slab_config_t	reuse
fr_time_delta_t	timeout

rlm_cache_memcached_thread_t

struct rlm_cache_memcached_thread_t

Definition at line 52 of file rlm_cache_memcached.c.

Collaboration diagram for rlm_cache_memcached_thread_t:

Data Fields
rlm_cache_memcached_t const *	inst
memcached_slab_list_t *	slab

Macro Definition Documentation

LOG_PREFIX

#define LOG_PREFIX   "cache - memcached"

Definition at line 25 of file rlm_cache_memcached.c.

Function Documentation

_mod_conn_free()

static int _mod_conn_free ( rlm_cache_memcached_handle_t *  mandle )

static

Free a connection handle.

Parameters

mandle

to free.

Definition at line 73 of file rlm_cache_memcached.c.

Here is the caller graph for this function:

cache_entry_expire()

static cache_status_t cache_entry_expire ( UNUSED rlm_cache_config_t const *  config, UNUSED void *  instance, request_t *  request, void *  handle, fr_value_box_t const *  key  )

static

Call delete the cache entry from memcached.

Note

This callback is not optional.

Parameters

[in]	config	for this instance of the rlm_cache module.
[in]	instance	Driver specific instance data.
[in]	request	The current request.
[in]	handle	the driver gave us when we called cache_acquire_t, or NULL if no cache_acquire_t callback was provided.
[in]	key	of entry to expire.

Returns

• CACHE_RECONNECT - If handle needs to be reinitialised/reconnected.
• CACHE_ERROR - If the entry couldn't be expired.
• CACHE_OK - If the entry was expired.
• CACHE_MISS - If the entry didn't exist, so couldn't be expired.

Definition at line 252 of file rlm_cache_memcached.c.

cache_entry_find()

static cache_status_t cache_entry_find ( rlm_cache_entry_t **  out, UNUSED rlm_cache_config_t const *  config, UNUSED void *  instance, request_t *  request, void *  handle, fr_value_box_t const *  key  )

static

Locate a cache entry in memcached.

If a cache entry is found, but the cache entry needs to be deserialized, the driver is expected to allocate an appropriately sized rlm_cache_entry_t, perform the deserialisation, and write a pointer to the new entry to out, returning CACHE_OK.

If the rlm_cache_handle_t is inviable, the driver should return CACHE_RECONNECT, to have it reinitialised/reconnected.

Parameters

[out]	out	Where to write a pointer to the retrieved entry (if there was one).
[in]	config	for this instance of the rlm_cache module.
[in]	instance	Driver specific instance data.
[in]	request	The current request.
[in]	handle	the driver gave us when we called cache_acquire_t, or NULL if no cache_acquire_t callback was provided.
[in]	key	to use to lookup cache entry

Returns

• CACHE_RECONNECT - If handle needs to be reinitialised/reconnected.
• CACHE_ERROR - If the lookup couldn't be completed.
• CACHE_OK - Lookup was successful.
• CACHE_MISS - No cached entry was found.

Definition at line 164 of file rlm_cache_memcached.c.

Here is the call graph for this function:

cache_entry_free()

static void cache_entry_free ( rlm_cache_entry_t *  c )

static

Locate a cache entry in memcached.

Note

This callback is optional, but the driver assume responsibility for freeing the cache_entry_t on cache_entry_expire_t.

If the driver does not need to keep a local copy of the cache entry, it should provide a callback to free the memory previously allocated for the cache entry by cache_entry_find_t or by rlm_cache.

Parameters

c	entry to free.

Definition at line 155 of file rlm_cache_memcached.c.

Here is the call graph for this function:

cache_entry_insert()

static cache_status_t cache_entry_insert ( UNUSED rlm_cache_config_t const *  config, UNUSED void *  instance, request_t *  request, void *  handle, const rlm_cache_entry_t *  c  )

static

Insert a new entry into the data store.

Serialize (if necessary) the entry passed to us, and write it to the cache with the key c->key.

The cache entry should not be freed by the driver, irrespective of success or failure. If the entry needs to be freed after insertion because a local copy should not be kept, the driver should provide a cache_entry_free_t callback.

If the rlm_cache_handle_t is inviable, the driver should return CACHE_RECONNECT, to have it reinitialised/reconnected.

Note

This callback is not optional.

This callback must overwrite existing cache entries on insert.

Parameters

config	for this instance of the rlm_cache module.
instance	Driver specific instance data.
request	The current request.
handle	the driver gave us when we called cache_acquire_t, or NULL if no cache_acquire_t callback was provided.
c	to insert.

Returns

• CACHE_RECONNECT - If handle needs to be reinitialised/reconnected.
• CACHE_ERROR - If the insert couldn't be completed.
• CACHE_OK - If the insert was successful.

Definition at line 215 of file rlm_cache_memcached.c.

Here is the call graph for this function:

memcached_conn_init()

static int memcached_conn_init ( rlm_cache_memcached_handle_t *  mandle, void *  uctx  )

static

Create a new memcached handle.

Definition at line 83 of file rlm_cache_memcached.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_conn_get()

static int mod_conn_get ( void **  handle, UNUSED rlm_cache_config_t const *  config, void *  instance, UNUSED request_t *  request  )

static

Get a memcached handle.

Note

This callback is optional. If it's not provided the handle argument to other callbacks will be NULL.

Parameters

[out]	handle	Where to write pointer to handle to access the cache with.
[in]	config	for this instance of the rlm_cache module.
[in]	instance	Driver specific instance data.
[in]	request	The current request.

Returns

• 0 on success.
• -1 on failure.

Definition at line 277 of file rlm_cache_memcached.c.

Here is the call graph for this function:

mod_conn_reconnect()

static int mod_conn_reconnect ( void **  handle, UNUSED rlm_cache_config_t const *  config, void *  instance, UNUSED request_t *  request  )

static

Reconnect a memcached handle.

Note

This callback is optional.

Parameters

[in,out]	handle	to reinitialise/reconnect.
[in]	config	for this instance of the rlm_cache module.
[in]	instance	Driver specific instance data.
[in]	request	The current request.

Returns

• 0 on success.
• -1 on failure.

Definition at line 308 of file rlm_cache_memcached.c.

Here is the call graph for this function:

mod_conn_release()

static void mod_conn_release ( UNUSED rlm_cache_config_t const *  config, UNUSED void *  instance, UNUSED request_t *  request, rlm_cache_handle_t *  handle  )

static

Release a memcached handle.

Note

This callback is optional.

Parameters

[in]	config	for this instance of the rlm_cache module.
[in]	instance	Driver specific instance data.
[in]	request	The current request.
[in]	handle	to release.

Definition at line 298 of file rlm_cache_memcached.c.

mod_instantiate()

static int mod_instantiate ( module_inst_ctx_t const *  mctx )

static

Create a new rlm_cache_memcached instance.

Parameters

[in]

mctx

Data required for instantiation.

Returns

• 0 on success.
• -1 on failure.

Definition at line 122 of file rlm_cache_memcached.c.

mod_load()

static int mod_load ( void  )

static

Definition at line 145 of file rlm_cache_memcached.c.

mod_thread_detach()

static int mod_thread_detach ( module_thread_inst_ctx_t const *  mctx )

static

Definition at line 341 of file rlm_cache_memcached.c.

Here is the call graph for this function:

mod_thread_instantiate()

static int mod_thread_instantiate ( module_thread_inst_ctx_t const *  mctx )

static

Definition at line 326 of file rlm_cache_memcached.c.

Here is the call graph for this function:

Variable Documentation

driver_config

const conf_parser_t driver_config[]

static

Initial value:

= {
        { FR_CONF_OFFSET("options", rlm_cache_memcached_t, options), .dflt = "--SERVER=localhost" },
        { FR_CONF_OFFSET("timeout", rlm_cache_memcached_t, timeout), .dflt = "3.0" },
        { FR_CONF_OFFSET_SUBSECTION("reuse", 0, rlm_cache_memcached_t, reuse, reuse_memcached_config) },
        CONF_PARSER_TERMINATOR
}

Definition at line 62 of file rlm_cache_memcached.c.

reuse_memcached_config

conf_parser_t reuse_memcached_config[]

static

Initial value:

= {
        FR_SLAB_CONFIG_CONF_PARSER
        CONF_PARSER_TERMINATOR
}

Definition at line 57 of file rlm_cache_memcached.c.

rlm_cache_memcached

rlm_cache_driver_t rlm_cache_memcached

Initial value:

= {
        .common = {
                .magic          = MODULE_MAGIC_INIT,
                .name           = "cache_memcached",
                .inst_size      = sizeof(rlm_cache_memcached_t),
                .config         = driver_config,
 
                .onload         = mod_load,
                .instantiate    = mod_instantiate,
                .thread_inst_size       = sizeof(rlm_cache_memcached_thread_t),
                .thread_instantiate     = mod_thread_instantiate,
                .thread_detach          = mod_thread_detach,
        },
 
        .free           = cache_entry_free,
 
        .find           = cache_entry_find,
        .insert         = cache_entry_insert,
        .expire         = cache_entry_expire,
 
        .acquire        = mod_conn_get,
        .release        = mod_conn_release,
        .reconnect      = mod_conn_reconnect
}

Definition at line 349 of file rlm_cache_memcached.c.