cache implements a cache with properties similar to a cuckoo-set. More...

#include <cuckoocache.h>

Collaboration diagram for CuckooCache::cache< Element, Hash >:

Public Member Functions
	cache ()
	You must always construct a cache with some elements via a subsequent call to setup or setup_bytes, otherwise operations may segfault.

uint32_t	setup (uint32_t new_size)
	setup initializes the container to store no more than new_size elements and no less than 2 elements.

std::optional< std::pair< uint32_t, size_t > >	setup_bytes (size_t bytes)
	setup_bytes is a convenience function which accounts for internal memory usage when deciding how many elements to store.

void	insert (Element e, bool replace=false)
	insert loops at most depth_limit times trying to insert a hash at various locations in the table via a variant of the Cuckoo Algorithm with eight hash locations.

bool	contains (const Key &k, const bool erase) const
	contains iterates through the hash locations for a given element and checks to see if it is present.

bool	get (Element &e, const bool erase) const
	get is almost identical to contains(), with the difference that it obtains the found element (for Elements that contain key and value, this has the effect of obtaining the found value).

Private Types
using	Key = typename Element::KeyType
	Key is the key type for this map or set.

Private Member Functions
std::array< uint32_t, 8 >	compute_hashes (const Key &k) const
	compute_hashes is convenience for not having to write out this expression everywhere we use the hash values of an Element.

constexpr uint32_t	invalid () const
	invalid returns a special index that can never be inserted to

void	allow_erase (uint32_t n) const
	allow_erase marks the element at index `n` as discardable.

void	please_keep (uint32_t n) const
	please_keep marks the element at index `n` as an entry that should be kept.

void	epoch_check ()
	epoch_check handles the changing of epochs for elements stored in the cache.

const Element *	find (const Key &k, const bool erase) const

Private Attributes
std::vector< Element >	table
	table stores all the elements

uint32_t	size
	size stores the total available slots in the hash table

bit_packed_atomic_flags	collection_flags
	The bit_packed_atomic_flags array is marked mutable because we want garbage collection to be allowed to occur from const methods.

std::vector< bool >	epoch_flags
	epoch_flags tracks how recently an element was inserted into the cache.

uint32_t	epoch_heuristic_counter
	epoch_heuristic_counter is used to determine when an epoch might be aged & an expensive scan should be done.

uint32_t	epoch_size
	epoch_size is set to be the number of elements supposed to be in a epoch.

uint8_t	depth_limit
	depth_limit determines how many elements insert should try to replace.

const Hash	hash_function
	hash_function is a const instance of the hash function.

Detailed Description

template<typename Element, typename Hash>
class CuckooCache::cache< Element, Hash >

cache implements a cache with properties similar to a cuckoo-set.

The cache is able to hold up to (~(uint32_t)0) - 1 elements.

Read Operations:

contains() for erase=false
get() for erase=false

Read+Erase Operations:

contains() for erase=true
get() for erase=true

Erase Operations:

allow_erase()

Write Operations:

Synchronization Free Operations:

User Must Guarantee:

Write requires synchronized access (e.g. a lock)
Read requires no concurrent Write, synchronized with last insert.
Erase requires no concurrent Write, synchronized with last insert.
An Erase caller must release all memory before allowing a new Writer.

Note on function names:

The name "allow_erase" is used because the real discard happens later.
The name "please_keep" is used because elements may be erased anyways on insert.

Template Parameters

Element	should be a movable and copyable type
Hash	should be a function/callable which takes a template parameter hash_select and an Element and extracts a hash from it. Should return high-entropy uint32_t hashes for `Hash h; h<0>(e) ... h<7>(e)`.

Definition at line 167 of file cuckoocache.h.

Member Typedef Documentation

◆ Key

template<typename Element , typename Hash >

using CuckooCache::cache< Element, Hash >::Key = typename Element::KeyType

private

Key is the key type for this map or set.

Definition at line 223 of file cuckoocache.h.

Constructor & Destructor Documentation

◆ cache()

template<typename Element , typename Hash >

CuckooCache::cache< Element, Hash >::cache ( )

inline

You must always construct a cache with some elements via a subsequent call to setup or setup_bytes, otherwise operations may segfault.

Definition at line 345 of file cuckoocache.h.

Member Function Documentation

◆ allow_erase()

template<typename Element , typename Hash >

void CuckooCache::cache< Element, Hash >::allow_erase ( uint32_t n ) const

inlineprivate

allow_erase marks the element at index n as discardable.

Threadsafe without any concurrent insert.

Parameters

n	the index to allow erasure of

Definition at line 284 of file cuckoocache.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ compute_hashes()

template<typename Element , typename Hash >

std::array< uint32_t, 8 > CuckooCache::cache< Element, Hash >::compute_hashes ( const Key & k ) const

inlineprivate

compute_hashes is convenience for not having to write out this expression everywhere we use the hash values of an Element.

We need to map the 32-bit input hash onto a hash bucket in a range [0, size) in a manner which preserves as much of the hash's uniformity as possible. Ideally this would be done by bitmasking but the size is usually not a power of two.

The naive approach would be to use a mod – which isn't perfectly uniform but so long as the hash is much larger than size it is not that bad. Unfortunately, mod/division is fairly slow on ordinary microprocessors (e.g. 90-ish cycles on haswell, ARM doesn't even have an instruction for it.); when the divisor is a constant the compiler will do clever tricks to turn it into a multiply+add+shift, but size is a run-time value so the compiler can't do that here.

One option would be to implement the same trick the compiler uses and compute the constants for exact division based on the size, as described in "{N}-bit Unsigned Division via {N}-bit Multiply-Add" by Arch D. Robison in 2005. But that code is somewhat complicated and the result is still slower than an even simpler option: see the FastRange32 function in util/fastrange.h.

The resulting non-uniformity is also more equally distributed which would be advantageous for something like linear probing, though it shouldn't matter one way or the other for a cuckoo table.

The primary disadvantage of this approach is increased intermediate precision is required but for a 32-bit random number we only need the high 32 bits of a 32*32->64 multiply, which means the operation is reasonably fast even on a typical 32-bit processor.

Parameters

k	The element whose hashes will be returned

Returns: Deterministic hashes derived from k uniformly mapped onto the range [0, size)

Definition at line 262 of file cuckoocache.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ contains()

template<typename Element , typename Hash >

bool CuckooCache::cache< Element, Hash >::contains	(	const Key &	k,
		const bool	erase
	)		const

inline

contains iterates through the hash locations for a given element and checks to see if it is present.

contains does not check garbage collected state (in other words, garbage is only collected when the space is needed), so:

insert(x);
if (contains(x, true))
    return contains(x, false);
else
    return true;

executed on a single thread will always return true!

This is a great property for re-org performance for example.

contains returns a bool set true if the element was found.

Parameters

k	the key to check
erase	whether to attempt setting the garbage collect flag

Postcondition: if erase is true and the element is found, then the garbage collect flag is set

Returns: true if the element is found, false otherwise

Definition at line 510 of file cuckoocache.h.

Here is the call graph for this function:

◆ epoch_check()

template<typename Element , typename Hash >

void CuckooCache::cache< Element, Hash >::epoch_check ( )

inlineprivate

epoch_check handles the changing of epochs for elements stored in the cache.

epoch_check should be run before every insert.

First, epoch_check decrements and checks the cheap heuristic, and then does a more expensive scan if the cheap heuristic runs out. If the expensive scan succeeds, the epochs are aged and old elements are allow_erased. The cheap heuristic is reset to retrigger after the worst case growth of the current epoch's elements would exceed the epoch_size.

Definition at line 303 of file cuckoocache.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ find()

template<typename Element , typename Hash >

const Element * CuckooCache::cache< Element, Hash >::find	(	const Key &	k,
		const bool	erase
	)		const

inlineprivate

Definition at line 536 of file cuckoocache.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get()

template<typename Element , typename Hash >

bool CuckooCache::cache< Element, Hash >::get	(	Element &	e,
		const bool	erase
	)		const

inline

get is almost identical to contains(), with the difference that it obtains the found element (for Elements that contain key and value, this has the effect of obtaining the found value).

Parameters

e	The element to check
erase	Whether to attempt setting the garbage collect flag

Postcondition: If the element is found, it is copied into e. If erase is true and the element is found, then the garbage collect flag is set.

Returns: true if the element is found, false otherwise

Definition at line 526 of file cuckoocache.h.

Here is the call graph for this function:

◆ insert()

template<typename Element , typename Hash >

void CuckooCache::cache< Element, Hash >::insert	(	Element	e,
		bool	replace = `false`
	)

inline

insert loops at most depth_limit times trying to insert a hash at various locations in the table via a variant of the Cuckoo Algorithm with eight hash locations.

It drops the last tried element if it runs out of depth before encountering an open slot.

Thus:

insert(x);

return contains(x, false);

is not guaranteed to return true.

Parameters

e	The element to insert
replace	Whether to replace if an existing element with the same key is found.

Postcondition: one of the following: All previously inserted elements and e are now in the table, one previously inserted element is evicted from the table, the entry attempted to be inserted is evicted. If replace is true and a matching element already exists, it is updated accordingly.

Swap with the element at the location that was not the last one looked at. Example:

On first iteration, last_loc == invalid(), find returns last, so last_loc defaults to locs[0].
On further iterations, where last_loc == locs[k], last_loc will go to locs[k+1 % 8], i.e., next of the 8 indices wrapping around to 0 if needed.

This prevents moving the element we just put in.

The swap is not a move – we must switch onto the evicted element for the next iteration.

Definition at line 424 of file cuckoocache.h.

Here is the call graph for this function:

◆ invalid()

template<typename Element , typename Hash >

constexpr uint32_t CuckooCache::cache< Element, Hash >::invalid ( ) const

inlineconstexprprivate

invalid returns a special index that can never be inserted to

Returns: the special constexpr index that can never be inserted to

Definition at line 277 of file cuckoocache.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ please_keep()

template<typename Element , typename Hash >

void CuckooCache::cache< Element, Hash >::please_keep ( uint32_t n ) const

inlineprivate

please_keep marks the element at index n as an entry that should be kept.

Threadsafe without any concurrent insert.

Parameters

n	the index to prioritize keeping

Definition at line 291 of file cuckoocache.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setup()

template<typename Element , typename Hash >

uint32_t CuckooCache::cache< Element, Hash >::setup ( uint32_t new_size )

inline

setup initializes the container to store no more than new_size elements and no less than 2 elements.

setup should only be called once.

Parameters

new_size the desired number of elements to store

Returns: the maximum number of elements storable

Definition at line 359 of file cuckoocache.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setup_bytes()

template<typename Element , typename Hash >

std::optional< std::pair< uint32_t, size_t > > CuckooCache::cache< Element, Hash >::setup_bytes ( size_t bytes )

inline

setup_bytes is a convenience function which accounts for internal memory usage when deciding how many elements to store.

It isn't perfect because it doesn't account for any overhead (struct size, MallocUsage, collection and epoch flags). This was done to simplify selecting a power of two size. In the expected use case, an extra two bits per entry should be negligible compared to the size of the elements.

Parameters

bytes the approximate number of bytes to use for this data structure

Returns: A pair of the maximum number of elements storable (see setup() documentation for more detail) and the approxmiate total size of these elements in bytes or std::nullopt if the size requested is too large.

Definition at line 387 of file cuckoocache.h.

Here is the call graph for this function:

Member Data Documentation

◆ collection_flags

template<typename Element , typename Hash >

bit_packed_atomic_flags CuckooCache::cache< Element, Hash >::collection_flags

mutableprivate

The bit_packed_atomic_flags array is marked mutable because we want garbage collection to be allowed to occur from const methods.

Definition at line 179 of file cuckoocache.h.

◆ depth_limit

template<typename Element , typename Hash >

uint8_t CuckooCache::cache< Element, Hash >::depth_limit

private

depth_limit determines how many elements insert should try to replace.

Should be set to log2(n).

Definition at line 211 of file cuckoocache.h.

◆ epoch_flags

template<typename Element , typename Hash >

std::vector<bool> CuckooCache::cache< Element, Hash >::epoch_flags

mutableprivate

epoch_flags tracks how recently an element was inserted into the cache.

true denotes recent, false denotes not-recent. See insert() method for full semantics.

Definition at line 186 of file cuckoocache.h.

◆ epoch_heuristic_counter

template<typename Element , typename Hash >

uint32_t CuckooCache::cache< Element, Hash >::epoch_heuristic_counter

private

epoch_heuristic_counter is used to determine when an epoch might be aged & an expensive scan should be done.

epoch_heuristic_counter is decremented on insert and reset to the new number of inserts which would cause the epoch to reach epoch_size when it reaches zero.

Definition at line 194 of file cuckoocache.h.

◆ epoch_size

template<typename Element , typename Hash >

uint32_t CuckooCache::cache< Element, Hash >::epoch_size

private

epoch_size is set to be the number of elements supposed to be in a epoch.

When the number of non-erased elements in an epoch exceeds epoch_size, a new epoch should be started and all current entries demoted. epoch_size is set to be 45% of size because we want to keep load around 90%, and we support 3 epochs at once – one "dead" which has been erased, one "dying" which has been marked to be erased next, and one "living" which new inserts add to.

Definition at line 205 of file cuckoocache.h.

◆ hash_function

template<typename Element , typename Hash >

const Hash CuckooCache::cache< Element, Hash >::hash_function

private

hash_function is a const instance of the hash function.

It cannot be static or initialized at call time as it may have internal state (such as a nonce).

Definition at line 218 of file cuckoocache.h.

◆ size

template<typename Element , typename Hash >

uint32_t CuckooCache::cache< Element, Hash >::size

private

size stores the total available slots in the hash table

Definition at line 173 of file cuckoocache.h.

◆ table

template<typename Element , typename Hash >

std::vector<Element> CuckooCache::cache< Element, Hash >::table

private

table stores all the elements

Definition at line 170 of file cuckoocache.h.

The documentation for this class was generated from the following file:

src/cuckoocache.h

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Key

Constructor & Destructor Documentation

◆ cache()

Member Function Documentation

◆ allow_erase()

◆ compute_hashes()

◆ contains()

◆ epoch_check()

◆ find()

◆ get()

◆ insert()

◆ invalid()

◆ please_keep()

◆ setup()

◆ setup_bytes()

Member Data Documentation

◆ collection_flags

◆ depth_limit

◆ epoch_flags

◆ epoch_heuristic_counter

◆ epoch_size

◆ hash_function

◆ size

◆ table