Data Structures | Functions
val_kcache.h File Reference

This file contains functions for caching validated key entries. More...

#include "util/storage/slabhash.h"

Data Structures

struct  key_cache
 Key cache. More...
 

Functions

struct key_cachekey_cache_create (struct config_file *cfg)
 Create the key cache. More...
 
void key_cache_delete (struct key_cache *kcache)
 Delete the key cache. More...
 
void key_cache_insert (struct key_cache *kcache, struct key_entry_key *kkey, struct module_qstate *qstate)
 Insert or update a key cache entry. More...
 
void key_cache_remove (struct key_cache *kcache, uint8_t *name, size_t namelen, uint16_t key_class)
 Remove an entry from the key cache. More...
 
struct key_entry_keykey_cache_obtain (struct key_cache *kcache, uint8_t *name, size_t namelen, uint16_t key_class, struct regional *region, time_t now)
 Lookup key entry in the cache. More...
 
size_t key_cache_get_mem (struct key_cache *kcache)
 Get memory in use by the key cache. More...
 

Detailed Description

This file contains functions for caching validated key entries.

Function Documentation

struct key_cache* key_cache_create ( struct config_file cfg)

Create the key cache.

Parameters
cfgconfig settings for the key cache.
Returns
new key cache or NULL on malloc failure.

References HASH_DEFAULT_STARTARRAY, config_file::key_cache_size, config_file::key_cache_slabs, key_entry_compfunc(), key_entry_deldatafunc(), key_entry_delkeyfunc(), key_entry_sizefunc(), log_err(), key_cache::slab, and slabhash_create().

Referenced by val_apply_cfg().

void key_cache_delete ( struct key_cache kcache)

Delete the key cache.

Parameters
kcacheto delete

References key_cache::slab, and slabhash_delete().

Referenced by val_deinit().

void key_cache_insert ( struct key_cache kcache,
struct key_entry_key kkey,
struct module_qstate qstate 
)

Insert or update a key cache entry.

Note that the insert may silently fail if there is not enough memory.

Parameters
kcachethe key cache.
kkeykey entry key, assumed malloced in a region, is copied to perform update or insertion. Its data pointer is also copied.
qstatestore errinf reason in case its bad.

References module_env::cfg, lruhash_entry::data, key_entry_key::entry, module_qstate::env, module_qstate::errinf, errinf_to_str(), lruhash_entry::hash, key_entry_copy(), key_entry_hash(), key_entry_isbad(), key_entry_set_reason(), key_cache::slab, slabhash_insert(), and config_file::val_log_level.

Referenced by process_dnskey_response(), process_prime_response(), and processValidate().

void key_cache_remove ( struct key_cache kcache,
uint8_t *  name,
size_t  namelen,
uint16_t  key_class 
)

Remove an entry from the key cache.

Parameters
kcachethe key cache.
namefor what name to look; uncompressed wireformat
namelenlength of the name.
key_classclass of the key.

References key_entry_key::entry, lruhash_entry::hash, lruhash_entry::key, key_entry_key::key_class, key_entry_hash(), key_entry_key::name, key_entry_key::namelen, key_cache::slab, and slabhash_remove().

Referenced by probe_anchor().

struct key_entry_key* key_cache_obtain ( struct key_cache kcache,
uint8_t *  name,
size_t  namelen,
uint16_t  key_class,
struct regional region,
time_t  now 
)

Lookup key entry in the cache.

Looks up the closest key entry above the given name.

Parameters
kcachethe key cache.
namefor what name to look; uncompressed wireformat
namelenlength of the name.
key_classclass of the key.
regiona copy of the key_entry is allocated in this region.
nowcurrent time.
Returns
pointer to a newly allocated key_entry copy in the region, if a key entry could be found, and allocation succeeded and TTL was OK. Otherwise, NULL is returned.

References lruhash_entry::data, dname_is_root(), dname_remove_label(), key_entry_key::entry, key_cache_search(), key_entry_copy_toregion(), lruhash_entry::lock, and key_entry_data::ttl.

Referenced by iter_indicates_dnssec(), and processInit().

size_t key_cache_get_mem ( struct key_cache kcache)

Get memory in use by the key cache.

Parameters
kcachethe key cache.
Returns
memory in use in bytes.

References key_cache::slab, and slabhash_get_mem().

Referenced by val_get_mem().