rlm_cache.c File Reference

Cache values and merge them back into future requests. More...

#include <freeradius-devel/server/base.h>
#include <freeradius-devel/server/module_rlm.h>
#include <freeradius-devel/server/modpriv.h>
#include <freeradius-devel/util/debug.h>
#include <freeradius-devel/util/types.h>
#include <freeradius-devel/unlang/xlat_func.h>
#include "rlm_cache.h"

Include dependency graph for rlm_cache.c:

Go to the source code of this file.

Data Structures
struct	cache_call_env_t
struct	cache_htrie_t
struct	cache_it_ctx_t
	Additional resume context used by mod_cache_it. More...
struct	cache_rctx_t
	Resume context when driver is async. More...

Macros
#define	FIXUP_KEY(_fail, _invalid)
	Macro to reduce boilerplate in all the module methods / xlat functions If multiple values are in the input list, concat them as a string Then check that a variable length key is longer than zero bytes.
#define	LOG_PREFIX   mctx->mi->name

Functions
static int	cache_acquire (rlm_cache_handle_t **out, rlm_cache_t const *inst, request_t *request)
	Get exclusive use of a handle to access the cache.
static rlm_cache_entry_t *	cache_alloc (rlm_cache_t const *inst, request_t *request)
	Allocate a cache entry.
static unlang_action_t	cache_expire (unlang_result_t *p_result, void **rctx_out, rlm_cache_t const *inst, request_t *request, rlm_cache_handle_t **handle, fr_value_box_t const *key)
	Expire a cache entry (removing it from the datastore)
static void	cache_expire_cancel (module_ctx_t const *mctx, request_t *request, UNUSED fr_signal_t action)
static unlang_action_t	cache_expire_resume (unlang_result_t *p_result, rlm_cache_t const *inst, request_t *request, rlm_cache_handle_t **handle, void *rctx)
	Resume callback after async cache expire.
static unlang_action_t	cache_find (unlang_result_t *p_result, rlm_cache_entry_t **out, void **out_rctx, rlm_cache_t const *inst, request_t *request, rlm_cache_handle_t **handle, fr_value_box_t const *key)
	Find a cached entry.
static void	cache_find_cancel (module_ctx_t const *mctx, request_t *request, UNUSED fr_signal_t action)
static unlang_action_t	cache_find_results (unlang_result_t *p_result, rlm_cache_entry_t **out, rlm_cache_t const *inst, request_t *request, rlm_cache_handle_t **handle, fr_value_box_t const *key, rlm_cache_entry_t *c)
	Process results of cache find - either synchronous or async.
static unlang_action_t	cache_find_resume (unlang_result_t *p_result, rlm_cache_entry_t **out, rlm_cache_t const *inst, request_t *request, rlm_cache_handle_t **handle, fr_value_box_t const *key, void *rctx)
	Resume callback after async cache find.
static void	cache_free (rlm_cache_t const *inst, rlm_cache_entry_t **c)
	Free memory associated with a cache entry.
static unlang_action_t	cache_insert (unlang_result_t *p_result, void **out_rctx, rlm_cache_t const *inst, request_t *request, rlm_cache_handle_t **handle, fr_value_box_t const *key, map_list_t const *maps, fr_time_delta_t ttl)
	Create and insert a cache entry.
static void	cache_insert_cancel (module_ctx_t const *mctx, request_t *request, UNUSED fr_signal_t action)
static unlang_action_t	cache_insert_resume (unlang_result_t *p_result, request_t *request, rlm_cache_t const *inst, rlm_cache_handle_t **handle, fr_time_delta_t *ttl, void *rctx)
static int	cache_key_parse (TALLOC_CTX *ctx, void *out, tmpl_rules_t const *t_rules, CONF_ITEM *ci, call_env_ctx_t const *cec, call_env_parser_t const *rule)
static rlm_rcode_t	cache_merge (rlm_cache_t const *inst, request_t *request, rlm_cache_entry_t *c)
	Merge a cached entry into a request_t.
static unlang_action_t	cache_module_yield (request_t *request, rlm_cache_handle_t *handle, fr_value_box_t const *key, rlm_cache_entry_t *entry, fr_time_delta_t *ttl, module_method_t resume, unlang_module_signal_t cancel, void *driver_rctx, void *uctx)
static int	cache_reconnect (rlm_cache_handle_t **handle, rlm_cache_t const *inst, request_t *request)
	Reconnect an suspected inviable handle.
static void	cache_release (rlm_cache_t const *inst, request_t *request, rlm_cache_handle_t **handle)
	Release a handle we previously acquired.
static unlang_action_t	cache_set_ttl (unlang_result_t *p_result, void **out_rctx, rlm_cache_t const *inst, request_t *request, rlm_cache_handle_t **handle, rlm_cache_entry_t *c)
	Update the TTL of an entry.
static void	cache_set_ttl_cancel (module_ctx_t const *mctx, request_t *request, UNUSED fr_signal_t action)
static unlang_action_t	cache_set_ttl_resume (unlang_result_t *p_result, request_t *request, rlm_cache_t const *inst, rlm_cache_handle_t *handle, void *rctx)
static xlat_action_t	cache_ttl_get_xlat (TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, UNUSED fr_value_box_list_t *in)
static xlat_action_t	cache_ttl_get_xlat_results (TALLOC_CTX *ctx, unlang_result_t *result, request_t *request, rlm_cache_t const *inst, rlm_cache_handle_t *handle, rlm_cache_entry_t *c, fr_dcursor_t *out)
static xlat_action_t	cache_ttl_get_xlat_resume (UNUSED TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, UNUSED request_t *request, UNUSED fr_value_box_list_t *in)
static void	cache_unref (request_t *request, rlm_cache_t const *inst, rlm_cache_entry_t *entry, rlm_cache_handle_t *handle)
	Release the allocated resources and cleanup the avps.
static int	cache_update_section_parse (TALLOC_CTX *ctx, call_env_parsed_head_t *out, tmpl_rules_t const *t_rules, CONF_ITEM *ci, call_env_ctx_t const *cec, call_env_parser_t const *rule)
static int	cache_update_section_parse (TALLOC_CTX *ctx, call_env_parsed_head_t *out, tmpl_rules_t const *t_rules, CONF_ITEM *ci, UNUSED call_env_ctx_t const *cec, UNUSED call_env_parser_t const *rule)
static int	cache_verify (map_t *map, void *uctx)
	Verify that a map in the cache section makes sense.
static xlat_action_t	cache_xlat (TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in)
	Allow single attribute values to be retrieved from the cache.
static xlat_action_t	cache_xlat_results (TALLOC_CTX *ctx, unlang_result_t *result, request_t *request, rlm_cache_t const *inst, rlm_cache_handle_t *handle, rlm_cache_entry_t *c, tmpl_t *target, fr_dcursor_t *out)
static xlat_action_t	cache_xlat_resume (UNUSED TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, UNUSED request_t *request, UNUSED fr_value_box_list_t *in)
static int	mod_bootstrap (module_inst_ctx_t const *mctx)
	Register module xlats.
static unlang_action_t	mod_cache_it (unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
	Do caching checks.
static unlang_action_t	mod_cache_it_expire (unlang_result_t *p_result, request_t *request, rlm_cache_t const *inst, rlm_cache_handle_t *handle, cache_rctx_t *rctx)
static unlang_action_t	mod_cache_it_expire_results (unlang_result_t *p_result, unlang_result_t *tmp, request_t *request, rlm_cache_t const *inst, rlm_cache_handle_t *handle, rlm_cache_entry_t *entry)
static unlang_action_t	mod_cache_it_expire_resume (unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
static int	mod_cache_it_find_results (unlang_result_t *p_result, unlang_result_t *tmp, NDEBUG_UNUSED rlm_cache_t const *inst, NDEBUG_UNUSED rlm_cache_handle_t *handle, cache_it_ctx_t *ctx)
static unlang_action_t	mod_cache_it_find_resume (unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
static unlang_action_t	mod_cache_it_finish (request_t *request, rlm_cache_t const *inst, rlm_cache_handle_t *handle, rlm_cache_entry_t *c)
static unlang_action_t	mod_cache_it_insert_results (unlang_result_t *p_result, unlang_result_t *tmp, request_t *request, rlm_cache_t const *inst, rlm_cache_handle_t *handle, rlm_cache_entry_t *c)
static unlang_action_t	mod_cache_it_insert_resume (unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
static int	mod_cache_it_merge_results (unlang_result_t *p_result, request_t *request, rlm_cache_t const *inst, NDEBUG_UNUSED rlm_cache_handle_t *handle, cache_it_ctx_t *ctx, rlm_cache_entry_t *c)
static unlang_action_t	mod_cache_it_merge_resume (unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
static unlang_action_t	mod_cache_it_ttl (unlang_result_t *p_result, request_t *request, rlm_cache_t const *inst, rlm_cache_handle_t *handle, cache_rctx_t *rctx)
static unlang_action_t	mod_cache_it_ttl_results (unlang_result_t *p_result, unlang_result_t *tmp, request_t *request, rlm_cache_t const *inst, rlm_cache_handle_t *handle, cache_rctx_t *rctx)
static unlang_action_t	mod_cache_it_ttl_resume (unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
static int	mod_detach (module_detach_ctx_t const *mctx)
	Free any memory allocated under the instance.
static int	mod_instantiate (module_inst_ctx_t const *mctx)
	Create a new rlm_cache_instance.
static unlang_action_t	mod_method_clear (unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
	Delete the entries by ${key}.
static unlang_action_t	mod_method_clear_expire_resume (unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
static unlang_action_t	mod_method_clear_find_results (unlang_result_t *p_result, request_t *request, rlm_cache_t const *inst, rlm_cache_handle_t *handle, fr_value_box_t const *key, rlm_cache_entry_t *entry)
	Common result handdling after clear method does a find.
static unlang_action_t	mod_method_clear_find_resume (unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
static unlang_action_t	mod_method_common_results (unlang_result_t *p_result, request_t *request, rlm_cache_t const *inst, rlm_cache_handle_t *handle, rlm_cache_entry_t *entry)
	Common result handling for any module method which returns updated for success.
static unlang_action_t	mod_method_common_resume (unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
static unlang_action_t	mod_method_load (unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
	Load the avps by ${key}.
static unlang_action_t	mod_method_load_results (unlang_result_t *p_result, request_t *request, rlm_cache_t const *inst, rlm_cache_handle_t *handle, rlm_cache_entry_t *entry)
	Common result handling for load method.
static unlang_action_t	mod_method_load_resume (unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
static unlang_action_t	mod_method_status (unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
	Get the status by ${key} (without load)
static unlang_action_t	mod_method_status_results (unlang_result_t *p_result, request_t *request, rlm_cache_t const *inst, rlm_cache_handle_t *handle, rlm_cache_entry_t *entry)
	Common result handling for status method.
static unlang_action_t	mod_method_status_resume (unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
static unlang_action_t	mod_method_store (unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
	Create a cache entry if it does not already exist.
static unlang_action_t	mod_method_store_find_results (unlang_result_t *p_result, request_t *request, rlm_cache_t const *inst, rlm_cache_handle_t *handle, cache_call_env_t *env, rlm_cache_entry_t *entry)
	Common result handdling after store method does a find.
static unlang_action_t	mod_method_store_find_resume (unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
static unlang_action_t	mod_method_ttl (unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
	Change the TTL on an existing entry.
static unlang_action_t	mod_method_ttl_find_results (unlang_result_t *p_result, request_t *request, rlm_cache_t const *inst, rlm_cache_handle_t *handle, rlm_cache_entry_t *entry)
	Common result handling after ttl method does a find.
static unlang_action_t	mod_method_ttl_find_resume (unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
static unlang_action_t	mod_method_ttl_resume (unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
static unlang_action_t	mod_method_update (unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
	Create, or update a cache entry.
static unlang_action_t	mod_method_update_expire_resume (unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
static unlang_action_t	mod_method_update_find_results (unlang_result_t *p_result, request_t *request, rlm_cache_t const *inst, rlm_cache_handle_t *handle, cache_call_env_t *env, rlm_cache_entry_t *entry)
	Common result handdling after update method does a find.
static unlang_action_t	mod_method_update_find_resume (unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
int	submodule_parse (TALLOC_CTX *ctx, void *out, void *parent, CONF_ITEM *ci, conf_parser_t const *rule)

Variables
static fr_dict_attr_t const *	attr_cache_allow_insert
static fr_dict_attr_t const *	attr_cache_allow_merge
static fr_dict_attr_t const *	attr_cache_entry_hits
static fr_dict_attr_t const *	attr_cache_merge_new
static fr_dict_attr_t const *	attr_cache_status_only
static fr_dict_attr_t const *	attr_cache_ttl
static const call_env_method_t	cache_method_env
static xlat_arg_parser_t const	cache_xlat_args []
static fr_dict_t const *	dict_freeradius
static const conf_parser_t	module_config []
module_rlm_t	rlm_cache
fr_dict_autoload_t	rlm_cache_dict []
fr_dict_attr_autoload_t	rlm_cache_dict_attr []

Detailed Description

Cache values and merge them back into future requests.

Id

06851b77d75d9812802e3fff61bf1945d12f1f96

Copyright

2024 Arran Cudbard-Bell (a.cud.nosp@m.bard.nosp@m.b@fre.nosp@m.erad.nosp@m.ius.o.nosp@m.rg)

2012-2014 The FreeRADIUS server project

Definition in file rlm_cache.c.

---

Data Structure Documentation

cache_call_env_t

struct cache_call_env_t

Definition at line 57 of file rlm_cache.c.

Data Fields
fr_value_box_list_t	key	To lookup the cache entry with.
map_list_t *	maps	Attribute map applied to cache entries.

cache_htrie_t

struct cache_htrie_t

Definition at line 62 of file rlm_cache.c.

Data Fields
fr_type_t	ktype	Key type.

cache_it_ctx_t

struct cache_it_ctx_t

Additional resume context used by mod_cache_it.

Definition at line 80 of file rlm_cache.c.

Collaboration diagram for cache_it_ctx_t:

Data Fields
cache_call_env_t *	env
int	exists
bool	expire
bool	insert
bool	merge
bool	set_ttl

cache_rctx_t

struct cache_rctx_t

Resume context when driver is async.

Definition at line 69 of file rlm_cache.c.

Collaboration diagram for cache_rctx_t:

Data Fields
rlm_cache_entry_t *	entry
rlm_cache_handle_t *	handle
fr_value_box_t const *	key
void *	rctx	Driver resume context.
fr_time_delta_t	ttl
void *	uctx	Module method context.

Macro Definition Documentation

FIXUP_KEY

#define FIXUP_KEY	(		_fail,
			_invalid
	)

Value:

if ((fr_value_box_list_num_elements(&env->key) > 1) && \
    (fr_value_box_list_concat_in_place(key, key, &env->key, FR_TYPE_STRING, \
                                       FR_VALUE_BOX_LIST_FREE, true, SIZE_MAX) < 0)) { \
        REDEBUG("Failed concatenating values to form the key"); \
        _fail; \
} \
if (fr_type_is_variable_size(key->type) && (key->vb_length == 0)) { \
        REDEBUG("Zero length key string is invalid"); \
        _invalid; \
}

Macro to reduce boilerplate in all the module methods / xlat functions If multiple values are in the input list, concat them as a string Then check that a variable length key is longer than zero bytes.

Definition at line 828 of file rlm_cache.c.

LOG_PREFIX

#define LOG_PREFIX   mctx->mi->name

Definition at line 27 of file rlm_cache.c.

Function Documentation

cache_acquire()

static int cache_acquire ( rlm_cache_handle_t **  out, rlm_cache_t const *  inst, request_t *  request  )

static

Get exclusive use of a handle to access the cache.

Definition at line 201 of file rlm_cache.c.

Here is the caller graph for this function:

cache_alloc()

static rlm_cache_entry_t * cache_alloc ( rlm_cache_t const *  inst, request_t *  request  )

static

Allocate a cache entry.

This is used so that drivers may use their own allocation functions to allocate structures larger than the normal rlm_cache_entry_t.

If the driver doesn't specify a custom allocation function, the cache entry is talloced in the NULL ctx.

Definition at line 241 of file rlm_cache.c.

Here is the caller graph for this function:

cache_expire()

static unlang_action_t cache_expire ( unlang_result_t *  p_result, void **  rctx_out, rlm_cache_t const *  inst, request_t *  request, rlm_cache_handle_t **  handle, fr_value_box_t const *  key  )

static

Expire a cache entry (removing it from the datastore)

Returns

• RLM_MODULE_OK on success.
• RLM_MODULE_NOTFOUND if no entry existed.
• RLM_MODULE_FAIL on failure.
• UNLANG_ACTION_YIELD if the driver yielded.

Definition at line 488 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

cache_expire_cancel()

static void cache_expire_cancel ( module_ctx_t const *  mctx, request_t *  request, UNUSED fr_signal_t  action  )

static

Definition at line 470 of file rlm_cache.c.

Here is the caller graph for this function:

cache_expire_resume()

static unlang_action_t cache_expire_resume ( unlang_result_t *  p_result, rlm_cache_t const *  inst, request_t *  request, rlm_cache_handle_t **  handle, void *  rctx  )

static

Resume callback after async cache expire.

Definition at line 449 of file rlm_cache.c.

Here is the caller graph for this function:

cache_find()

static unlang_action_t cache_find ( unlang_result_t *  p_result, rlm_cache_entry_t **  out, void **  out_rctx, rlm_cache_t const *  inst, request_t *  request, rlm_cache_handle_t **  handle, fr_value_box_t const *  key  )

static

Find a cached entry.

Returns

• RLM_MODULE_OK on cache hit.
• RLM_MODULE_FAIL on failure.
• RLM_MODULE_NOTFOUND on cache miss.
• UNLANG_ACTION_YIELD if the driver has yielded.

Definition at line 408 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

cache_find_cancel()

static void cache_find_cancel ( module_ctx_t const *  mctx, request_t *  request, UNUSED fr_signal_t  action  )

static

Definition at line 390 of file rlm_cache.c.

Here is the caller graph for this function:

cache_find_results()

static unlang_action_t cache_find_results ( unlang_result_t *  p_result, rlm_cache_entry_t **  out, rlm_cache_t const *  inst, request_t *  request, rlm_cache_handle_t **  handle, fr_value_box_t const *  key, rlm_cache_entry_t *  c  )

inlinestatic

Process results of cache find - either synchronous or async.

Definition at line 318 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

cache_find_resume()

static unlang_action_t cache_find_resume ( unlang_result_t *  p_result, rlm_cache_entry_t **  out, rlm_cache_t const *  inst, request_t *  request, rlm_cache_handle_t **  handle, fr_value_box_t const *  key, void *  rctx  )

static

Resume callback after async cache find.

Definition at line 363 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

cache_free()

static void cache_free ( rlm_cache_t const *  inst, rlm_cache_entry_t **  c  )

static

Free memory associated with a cache entry.

This does not necessarily remove the entry from the cache, cache_expire should be used for that.

This function should be called when an entry that is known to have been retrieved or inserted into a data store successfully, is no longer needed.

Some drivers (like rlm_cache_rbtree) don't register a free function. This means that the cache entry never needs to be explicitly freed.

Parameters

[in]	inst	Module instance.
[in,out]	c	Cache entry to free.

Definition at line 262 of file rlm_cache.c.

Here is the caller graph for this function:

cache_insert()

static unlang_action_t cache_insert ( unlang_result_t *  p_result, void **  out_rctx, rlm_cache_t const *  inst, request_t *  request, rlm_cache_handle_t **  handle, fr_value_box_t const *  key, map_list_t const *  maps, fr_time_delta_t  ttl  )

static

Create and insert a cache entry.

Returns

• RLM_MODULE_OK on success.
• RLM_MODULE_UPDATED if we merged the cache entry.
• RLM_MODULE_FAIL on failure.

Definition at line 554 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

cache_insert_cancel()

static void cache_insert_cancel ( module_ctx_t const *  mctx, request_t *  request, UNUSED fr_signal_t  action  )

static

Definition at line 537 of file rlm_cache.c.

Here is the caller graph for this function:

cache_insert_resume()

static unlang_action_t cache_insert_resume ( unlang_result_t *  p_result, request_t *  request, rlm_cache_t const *  inst, rlm_cache_handle_t **  handle, fr_time_delta_t *  ttl, void *  rctx  )

static

Definition at line 512 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

cache_key_parse()

static int cache_key_parse ( TALLOC_CTX *  ctx, void *  out, tmpl_rules_t const *  t_rules, CONF_ITEM *  ci, call_env_ctx_t const *  cec, call_env_parser_t const *  rule  )

static

Definition at line 137 of file rlm_cache.c.

Here is the call graph for this function:

cache_merge()

static rlm_rcode_t cache_merge ( rlm_cache_t const *  inst, request_t *  request, rlm_cache_entry_t *  c  )

static

Merge a cached entry into a request_t.

Returns

• RLM_MODULE_OK if no entries were merged.
• RLM_MODULE_UPDATED if entries were merged.

Definition at line 277 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

cache_module_yield()

static unlang_action_t cache_module_yield ( request_t *  request, rlm_cache_handle_t *  handle, fr_value_box_t const *  key, rlm_cache_entry_t *  entry, fr_time_delta_t *  ttl, module_method_t  resume, unlang_module_signal_t  cancel, void *  driver_rctx, void *  uctx  )

static

Definition at line 181 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

cache_reconnect()

static int cache_reconnect ( rlm_cache_handle_t **  handle, rlm_cache_t const *  inst, request_t *  request  )

static

Reconnect an suspected inviable handle.

Definition at line 226 of file rlm_cache.c.

Here is the caller graph for this function:

cache_release()

static void cache_release ( rlm_cache_t const *  inst, request_t *  request, rlm_cache_handle_t **  handle  )

static

Release a handle we previously acquired.

Definition at line 214 of file rlm_cache.c.

Here is the caller graph for this function:

cache_set_ttl()

static unlang_action_t cache_set_ttl ( unlang_result_t *  p_result, void **  out_rctx, rlm_cache_t const *  inst, request_t *  request, rlm_cache_handle_t **  handle, rlm_cache_entry_t *  c  )

static

Update the TTL of an entry.

Returns

• RLM_MODULE_OK on success.
• RLM_MODULE_FAIL on failure.

Definition at line 773 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

cache_set_ttl_cancel()

static void cache_set_ttl_cancel ( module_ctx_t const *  mctx, request_t *  request, UNUSED fr_signal_t  action  )

static

Definition at line 756 of file rlm_cache.c.

Here is the caller graph for this function:

cache_set_ttl_resume()

static unlang_action_t cache_set_ttl_resume ( unlang_result_t *  p_result, request_t *  request, rlm_cache_t const *  inst, rlm_cache_handle_t *  handle, void *  rctx  )

static

Definition at line 728 of file rlm_cache.c.

Here is the caller graph for this function:

cache_ttl_get_xlat()

static xlat_action_t cache_ttl_get_xlat ( TALLOC_CTX *  ctx, fr_dcursor_t *  out, xlat_ctx_t const *  xctx, request_t *  request, UNUSED fr_value_box_list_t *  in  )

static

Definition at line 1480 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

cache_ttl_get_xlat_results()

static xlat_action_t cache_ttl_get_xlat_results ( TALLOC_CTX *  ctx, unlang_result_t *  result, request_t *  request, rlm_cache_t const *  inst, rlm_cache_handle_t *  handle, rlm_cache_entry_t *  c, fr_dcursor_t *  out  )

static

Definition at line 1438 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

cache_ttl_get_xlat_resume()

static xlat_action_t cache_ttl_get_xlat_resume ( UNUSED TALLOC_CTX *  ctx, fr_dcursor_t *  out, xlat_ctx_t const *  xctx, UNUSED request_t *  request, UNUSED fr_value_box_list_t *  in  )

static

Definition at line 1463 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

cache_unref()

static void cache_unref ( request_t *  request, rlm_cache_t const *  inst, rlm_cache_entry_t *  entry, rlm_cache_handle_t *  handle  )

static

Release the allocated resources and cleanup the avps.

Definition at line 1517 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

cache_update_section_parse() [1/2]

static int cache_update_section_parse ( TALLOC_CTX *  ctx, call_env_parsed_head_t *  out, tmpl_rules_t const *  t_rules, CONF_ITEM *  ci, call_env_ctx_t const *  cec, call_env_parser_t const *  rule  )

static

cache_update_section_parse() [2/2]

static int cache_update_section_parse ( TALLOC_CTX *  ctx, call_env_parsed_head_t *  out, tmpl_rules_t const *  t_rules, CONF_ITEM *  ci, UNUSED call_env_ctx_t const *  cec, UNUSED call_env_parser_t const *  rule  )

static

Definition at line 2242 of file rlm_cache.c.

Here is the call graph for this function:

cache_verify()

static int cache_verify ( map_t *  map, void *  uctx  )

static

Verify that a map in the cache section makes sense.

Definition at line 2225 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

cache_xlat_results()

static xlat_action_t cache_xlat_results ( TALLOC_CTX *  ctx, unlang_result_t *  result, request_t *  request, rlm_cache_t const *  inst, rlm_cache_handle_t *  handle, rlm_cache_entry_t *  c, tmpl_t *  target, fr_dcursor_t *  out  )

static

Definition at line 1307 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

cache_xlat_resume()

static xlat_action_t cache_xlat_resume ( UNUSED TALLOC_CTX *  ctx, fr_dcursor_t *  out, xlat_ctx_t const *  xctx, UNUSED request_t *  request, UNUSED fr_value_box_list_t *  in  )

static

Definition at line 1359 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_bootstrap()

static int mod_bootstrap ( module_inst_ctx_t const *  mctx )

static

Register module xlats.

Definition at line 2305 of file rlm_cache.c.

Here is the call graph for this function:

mod_cache_it()

static unlang_action_t mod_cache_it ( unlang_result_t *  p_result, module_ctx_t const *  mctx, request_t *  request  )

static

Do caching checks.

Since we can update ANY VP list, we do exactly the same thing for all sections (autz / auth / etc.)

If you want to cache something different in different sections, configure another cache module.

Definition at line 1202 of file rlm_cache.c.

Here is the call graph for this function:

mod_cache_it_expire()

static unlang_action_t mod_cache_it_expire ( unlang_result_t *  p_result, request_t *  request, rlm_cache_t const *  inst, rlm_cache_handle_t *  handle, cache_rctx_t *  rctx  )

static

Definition at line 1096 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_cache_it_expire_results()

static unlang_action_t mod_cache_it_expire_results ( unlang_result_t *  p_result, unlang_result_t *  tmp, request_t *  request, rlm_cache_t const *  inst, rlm_cache_handle_t *  handle, rlm_cache_entry_t *  entry  )

inlinestatic

Definition at line 1056 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_cache_it_expire_resume()

static unlang_action_t mod_cache_it_expire_resume ( unlang_result_t *  p_result, module_ctx_t const *  mctx, request_t *  request  )

static

Definition at line 1081 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_cache_it_find_results()

static int mod_cache_it_find_results ( unlang_result_t *  p_result, unlang_result_t *  tmp, NDEBUG_UNUSED rlm_cache_t const *  inst, NDEBUG_UNUSED rlm_cache_handle_t *  handle, cache_it_ctx_t *  ctx  )

inlinestatic

Definition at line 1007 of file rlm_cache.c.

Here is the caller graph for this function:

mod_cache_it_find_resume()

static unlang_action_t mod_cache_it_find_resume ( unlang_result_t *  p_result, module_ctx_t const *  mctx, request_t *  request  )

static

Definition at line 1034 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_cache_it_finish()

static unlang_action_t mod_cache_it_finish ( request_t *  request, rlm_cache_t const *  inst, rlm_cache_handle_t *  handle, rlm_cache_entry_t *  c  )

static

Definition at line 847 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_cache_it_insert_results()

static unlang_action_t mod_cache_it_insert_results ( unlang_result_t *  p_result, unlang_result_t *  tmp, request_t *  request, rlm_cache_t const *  inst, rlm_cache_handle_t *  handle, rlm_cache_entry_t *  c  )

static

Definition at line 883 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_cache_it_insert_resume()

static unlang_action_t mod_cache_it_insert_resume ( unlang_result_t *  p_result, module_ctx_t const *  mctx, request_t *  request  )

static

Definition at line 909 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_cache_it_merge_results()

static int mod_cache_it_merge_results ( unlang_result_t *  p_result, request_t *  request, rlm_cache_t const *  inst, NDEBUG_UNUSED rlm_cache_handle_t *  handle, cache_it_ctx_t *  ctx, rlm_cache_entry_t *  c  )

inlinestatic

Definition at line 1148 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_cache_it_merge_resume()

static unlang_action_t mod_cache_it_merge_resume ( unlang_result_t *  p_result, module_ctx_t const *  mctx, request_t *  request  )

static

Definition at line 1173 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_cache_it_ttl()

static unlang_action_t mod_cache_it_ttl ( unlang_result_t *  p_result, request_t *  request, rlm_cache_t const *  inst, rlm_cache_handle_t *  handle, cache_rctx_t *  rctx  )

static

Definition at line 959 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_cache_it_ttl_results()

static unlang_action_t mod_cache_it_ttl_results ( unlang_result_t *  p_result, unlang_result_t *  tmp, request_t *  request, rlm_cache_t const *  inst, rlm_cache_handle_t *  handle, cache_rctx_t *  rctx  )

static

Definition at line 924 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_cache_it_ttl_resume()

static unlang_action_t mod_cache_it_ttl_resume ( unlang_result_t *  p_result, module_ctx_t const *  mctx, request_t *  request  )

static

Definition at line 944 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_detach()

static int mod_detach ( module_detach_ctx_t const *  mctx )

static

Free any memory allocated under the instance.

Definition at line 2205 of file rlm_cache.c.

mod_instantiate()

static int mod_instantiate ( module_inst_ctx_t const *  mctx )

static

Create a new rlm_cache_instance.

Definition at line 2276 of file rlm_cache.c.

mod_method_clear()

static unlang_action_t mod_method_clear ( unlang_result_t *  p_result, module_ctx_t const *  mctx, request_t *  request  )

static

Delete the entries by ${key}.

Returns

• RLM_MODULE_OK on success.
• RLM_MODULE_NOTFOUND on cache miss.
• RLM_MODULE_FAIL on failure.

Definition at line 2059 of file rlm_cache.c.

Here is the call graph for this function:

mod_method_clear_expire_resume()

static unlang_action_t mod_method_clear_expire_resume ( unlang_result_t *  p_result, module_ctx_t const *  mctx, request_t *  request  )

static

Definition at line 1994 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_method_clear_find_results()

static unlang_action_t mod_method_clear_find_results ( unlang_result_t *  p_result, request_t *  request, rlm_cache_t const *  inst, rlm_cache_handle_t *  handle, fr_value_box_t const *  key, rlm_cache_entry_t *  entry  )

inlinestatic

Common result handdling after clear method does a find.

Definition at line 2011 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_method_clear_find_resume()

static unlang_action_t mod_method_clear_find_resume ( unlang_result_t *  p_result, module_ctx_t const *  mctx, request_t *  request  )

static

Definition at line 2036 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_method_common_results()

static unlang_action_t mod_method_common_results ( unlang_result_t *  p_result, request_t *  request, rlm_cache_t const *  inst, rlm_cache_handle_t *  handle, rlm_cache_entry_t *  entry  )

inlinestatic

Common result handling for any module method which returns updated for success.

Definition at line 1690 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_method_common_resume()

static unlang_action_t mod_method_common_resume ( unlang_result_t *  p_result, module_ctx_t const *  mctx, request_t *  request  )

static

Definition at line 1702 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_method_load()

static unlang_action_t mod_method_load ( unlang_result_t *  p_result, module_ctx_t const *  mctx, request_t *  request  )

static

Load the avps by ${key}.

Returns

• RLM_MODULE_UPDATED on success.
• RLM_MODULE_NOTFOUND on cache miss.
• RLM_MODULE_FAIL on failure.

Definition at line 1663 of file rlm_cache.c.

Here is the call graph for this function:

mod_method_load_results()

static unlang_action_t mod_method_load_results ( unlang_result_t *  p_result, request_t *  request, rlm_cache_t const *  inst, rlm_cache_handle_t *  handle, rlm_cache_entry_t *  entry  )

inlinestatic

Common result handling for load method.

Definition at line 1622 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_method_load_resume()

static unlang_action_t mod_method_load_resume ( unlang_result_t *  p_result, module_ctx_t const *  mctx, request_t *  request  )

static

Definition at line 1641 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_method_status()

static unlang_action_t mod_method_status ( unlang_result_t *  p_result, module_ctx_t const *  mctx, request_t *  request  )

static

Get the status by ${key} (without load)

Returns

• RLM_MODULE_OK on success.
• RLM_MODULE_NOTFOUND on cache miss.
• RLM_MODULE_FAIL on failure.

Definition at line 1593 of file rlm_cache.c.

Here is the call graph for this function:

mod_method_status_results()

static unlang_action_t mod_method_status_results ( unlang_result_t *  p_result, request_t *  request, rlm_cache_t const *  inst, rlm_cache_handle_t *  handle, rlm_cache_entry_t *  entry  )

inlinestatic

Common result handling for status method.

Definition at line 1556 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_method_status_resume()

static unlang_action_t mod_method_status_resume ( unlang_result_t *  p_result, module_ctx_t const *  mctx, request_t *  request  )

static

Definition at line 1570 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_method_store()

static unlang_action_t mod_method_store ( unlang_result_t *  p_result, module_ctx_t const *  mctx, request_t *  request  )

static

Create a cache entry if it does not already exist.

Returns

• RLM_MODULE_NOOP if an entry already existed.
• RLM_MODULE_UPDATED if we inserted a cache entry.
• RLM_MODULE_FAIL on failure.

Definition at line 1966 of file rlm_cache.c.

Here is the call graph for this function:

mod_method_store_find_results()

static unlang_action_t mod_method_store_find_results ( unlang_result_t *  p_result, request_t *  request, rlm_cache_t const *  inst, rlm_cache_handle_t *  handle, cache_call_env_t *  env, rlm_cache_entry_t *  entry  )

inlinestatic

Common result handdling after store method does a find.

Definition at line 1896 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_method_store_find_resume()

static unlang_action_t mod_method_store_find_resume ( unlang_result_t *  p_result, module_ctx_t const *  mctx, request_t *  request  )

static

Definition at line 1942 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_method_ttl()

static unlang_action_t mod_method_ttl ( unlang_result_t *  p_result, module_ctx_t const *  mctx, request_t *  request  )

static

Change the TTL on an existing entry.

Returns

• RLM_MODULE_UPDATED on success.
• RLM_MODULE_NOTFOUND on cache miss.
• RLM_MODULE_FAIL on failure.

Definition at line 2167 of file rlm_cache.c.

Here is the call graph for this function:

mod_method_ttl_find_results()

static unlang_action_t mod_method_ttl_find_results ( unlang_result_t *  p_result, request_t *  request, rlm_cache_t const *  inst, rlm_cache_handle_t *  handle, rlm_cache_entry_t *  entry  )

inlinestatic

Common result handling after ttl method does a find.

Definition at line 2103 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_method_ttl_find_resume()

static unlang_action_t mod_method_ttl_find_resume ( unlang_result_t *  p_result, module_ctx_t const *  mctx, request_t *  request  )

static

Definition at line 2144 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_method_ttl_resume()

static unlang_action_t mod_method_ttl_resume ( unlang_result_t *  p_result, module_ctx_t const *  mctx, request_t *  request  )

static

Definition at line 2087 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_method_update()

static unlang_action_t mod_method_update ( unlang_result_t *  p_result, module_ctx_t const *  mctx, request_t *  request  )

static

Create, or update a cache entry.

Returns

• RLM_MODULE_OK on success.
• RLM_MODULE_UPDATED if we merged the cache entry.
• RLM_MODULE_FAIL on failure.

Definition at line 1865 of file rlm_cache.c.

Here is the call graph for this function:

mod_method_update_expire_resume()

static unlang_action_t mod_method_update_expire_resume ( unlang_result_t *  p_result, module_ctx_t const *  mctx, request_t *  request  )

static

Definition at line 1716 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_method_update_find_results()

static unlang_action_t mod_method_update_find_results ( unlang_result_t *  p_result, request_t *  request, rlm_cache_t const *  inst, rlm_cache_handle_t *  handle, cache_call_env_t *  env, rlm_cache_entry_t *  entry  )

inlinestatic

Common result handdling after update method does a find.

Definition at line 1747 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_method_update_find_resume()

static unlang_action_t mod_method_update_find_resume ( unlang_result_t *  p_result, module_ctx_t const *  mctx, request_t *  request  )

static

Definition at line 1841 of file rlm_cache.c.

Here is the call graph for this function:

Here is the caller graph for this function:

submodule_parse()

int submodule_parse	(	TALLOC_CTX *	ctx,
		void *	out,
		void *	parent,
		CONF_ITEM *	ci,
		conf_parser_t const *	rule
	)

Definition at line 124 of file rlm_cache.c.

Here is the call graph for this function:

Variable Documentation

attr_cache_allow_insert

fr_dict_attr_t const* attr_cache_allow_insert

static

Definition at line 109 of file rlm_cache.c.

attr_cache_allow_merge

fr_dict_attr_t const* attr_cache_allow_merge

static

Definition at line 108 of file rlm_cache.c.

attr_cache_entry_hits

fr_dict_attr_t const* attr_cache_entry_hits

static

Definition at line 111 of file rlm_cache.c.

attr_cache_merge_new

fr_dict_attr_t const* attr_cache_merge_new

static

Definition at line 106 of file rlm_cache.c.

attr_cache_status_only

fr_dict_attr_t const* attr_cache_status_only

static

Definition at line 107 of file rlm_cache.c.

attr_cache_ttl

fr_dict_attr_t const* attr_cache_ttl

static

Definition at line 110 of file rlm_cache.c.

cache_method_env

const call_env_method_t cache_method_env

static

Initial value:

= {
        FR_CALL_ENV_METHOD_OUT(cache_call_env_t),
        .env = (call_env_parser_t[]) {
                { FR_CALL_ENV_OFFSET("key", FR_TYPE_VOID, CALL_ENV_FLAG_REQUIRED, cache_call_env_t, key), .pair.func = cache_key_parse },
                { FR_CALL_ENV_SUBSECTION_FUNC("update", CF_IDENT_ANY, CALL_ENV_FLAG_NONE, cache_update_section_parse) },
                CALL_ENV_TERMINATOR
        }
}

Definition at line 89 of file rlm_cache.c.

cache_xlat_args

xlat_arg_parser_t const cache_xlat_args[]

static

Initial value:

= {
        { .required = true, .single = true, .type = FR_TYPE_STRING },
        XLAT_ARG_PARSER_TERMINATOR
}

Definition at line 1302 of file rlm_cache.c.

dict_freeradius

fr_dict_t const* dict_freeradius

static

Definition at line 98 of file rlm_cache.c.

module_config

const conf_parser_t module_config[]

static

Initial value:

= {
        { FR_CONF_OFFSET_TYPE_FLAGS("driver", FR_TYPE_VOID, 0, rlm_cache_t, driver_submodule), .dflt = "rbtree",
                         .func = submodule_parse },
        { FR_CONF_OFFSET("ttl", rlm_cache_config_t, ttl), .dflt = "500s" },
        { FR_CONF_OFFSET("max_entries", rlm_cache_config_t, max_entries), .dflt = "0" },
 
        
        { FR_CONF_OFFSET("epoch", rlm_cache_config_t, epoch), .dflt = "0" },
        { FR_CONF_OFFSET("add_stats", rlm_cache_config_t, stats), .dflt = "no" },
        CONF_PARSER_TERMINATOR
}

Definition at line 45 of file rlm_cache.c.

rlm_cache

module_rlm_t rlm_cache

Initial value:

= {
        .common = {
                .magic          = MODULE_MAGIC_INIT,
                .name           = "cache",
                .inst_size      = sizeof(rlm_cache_t),
                .config         = module_config,
                .bootstrap      = mod_bootstrap,
                .instantiate    = mod_instantiate,
                .detach         = mod_detach
        },
        .method_group = {
                .bindings = (module_method_binding_t[]){
                        { .section = SECTION_NAME("clear", CF_IDENT_ANY), .method = mod_method_clear, .method_env = &cache_method_env },
                        { .section = SECTION_NAME("load", CF_IDENT_ANY), .method = mod_method_load, .method_env = &cache_method_env },
                        { .section = SECTION_NAME("status", CF_IDENT_ANY), .method = mod_method_status, .method_env = &cache_method_env },
                        { .section = SECTION_NAME("store", CF_IDENT_ANY), .method = mod_method_store, .method_env = &cache_method_env },
                        { .section = SECTION_NAME("ttl", CF_IDENT_ANY), .method = mod_method_ttl, .method_env = &cache_method_env },
                        { .section = SECTION_NAME("update", CF_IDENT_ANY), .method = mod_method_update, .method_env = &cache_method_env },
                        { .section = SECTION_NAME(CF_IDENT_ANY, CF_IDENT_ANY), .method = mod_cache_it, .method_env = &cache_method_env },
                        MODULE_BINDING_TERMINATOR
                }
        }
}

Definition at line 2331 of file rlm_cache.c.

rlm_cache_dict

fr_dict_autoload_t rlm_cache_dict

Initial value:

= {
        { .out = &dict_freeradius, .proto = "freeradius" },
        DICT_AUTOLOAD_TERMINATOR
}

Definition at line 101 of file rlm_cache.c.

rlm_cache_dict_attr

fr_dict_attr_autoload_t rlm_cache_dict_attr

Initial value:

= {
        { .out = &attr_cache_merge_new, .name = "Cache-Merge-New", .type = FR_TYPE_BOOL, .dict = &dict_freeradius },
        { .out = &attr_cache_status_only, .name = "Cache-Status-Only", .type = FR_TYPE_BOOL, .dict = &dict_freeradius },
        { .out = &attr_cache_allow_merge, .name = "Cache-Allow-Merge", .type = FR_TYPE_BOOL, .dict = &dict_freeradius },
        { .out = &attr_cache_allow_insert, .name = "Cache-Allow-Insert", .type = FR_TYPE_BOOL, .dict = &dict_freeradius },
        { .out = &attr_cache_ttl, .name = "Cache-TTL", .type = FR_TYPE_INT32, .dict = &dict_freeradius },
        { .out = &attr_cache_entry_hits, .name = "Cache-Entry-Hits", .type = FR_TYPE_UINT32, .dict = &dict_freeradius },
        DICT_AUTOLOAD_TERMINATOR
}

Definition at line 114 of file rlm_cache.c.