Documentation
¶
Overview ¶
Package ristretto is a fast, fixed size, in-memory cache with a dual focus on throughput and hit ratio performance. You can easily add Ristretto to an existing system and keep the most valuable data where you need it.
Package ristretto includes multiple probabalistic data structures needed for admission/eviction metadata. Most are Counting Bloom Filter variations, but a caching-specific feature that is also required is a "freshness" mechanism, which basically serves as a "lifetime" process. This freshness mechanism was described in the original TinyLFU paper 1, but other mechanisms may be better suited for certain data distributions.
Index ¶
- Variables
- type Cache
- func (c *Cache) Clear()
- func (c *Cache) Close()
- func (c *Cache) Delete(key string)
- func (c *Cache) Evictions() int64
- func (c *Cache) ForEach(forEach func(any) bool)
- func (c *Cache) Get(key string) (any, bool)
- func (c *Cache) Hits() int64
- func (c *Cache) Len() int
- func (c *Cache) MaxCapacity() int64
- func (c *Cache) Misses() int64
- func (c *Cache) Set(key string, value any) bool
- func (c *Cache) SetCapacity(maxCost int64)
- func (c *Cache) SetWithCost(key string, value any, cost int64) bool
- func (c *Cache) UsedCapacity() int64
- func (c *Cache) Wait()
- type Config
- type Item
- type Metrics
- func (p *Metrics) Clear()
- func (p *Metrics) CostAdded() uint64
- func (p *Metrics) CostEvicted() uint64
- func (p *Metrics) GetsDropped() uint64
- func (p *Metrics) GetsKept() uint64
- func (p *Metrics) Hits() uint64
- func (p *Metrics) KeysAdded() uint64
- func (p *Metrics) KeysEvicted() uint64
- func (p *Metrics) KeysUpdated() uint64
- func (p *Metrics) Misses() uint64
- func (p *Metrics) Ratio() float64
- func (p *Metrics) SetsDropped() uint64
- func (p *Metrics) SetsRejected() uint64
- func (p *Metrics) String() string
Constants ¶
This section is empty.
Variables ¶
var CacheItemSize = hack.RuntimeAllocSize(int64(unsafe.Sizeof(storeItem{})))
CacheItemSize is the overhead in bytes for every stored cache item
Functions ¶
This section is empty.
Types ¶
type Cache ¶
type Cache struct {
// Metrics contains a running log of important statistics like hits, misses,
// and dropped items.
Metrics *Metrics
// contains filtered or unexported fields
}
Cache is a thread-safe implementation of a hashmap with a TinyLFU admission policy and a Sampled LFU eviction policy. You can use the same Cache instance from as many goroutines as you want.
func (*Cache) Clear ¶
func (c *Cache) Clear()
Clear empties the hashmap and zeroes all policy counters. Note that this is not an atomic operation (but that shouldn't be a problem as it's assumed that Set/Get calls won't be occurring until after this).
func (*Cache) ForEach ¶
ForEach yields all the values currently stored in the cache to the given callback. The callback may return `false` to stop the iteration early.
func (*Cache) Get ¶
Get returns the value (if any) and a boolean representing whether the value was found or not. The value can be nil and the boolean can be true at the same time.
func (*Cache) MaxCapacity ¶
MaxCapacity returns the max cost of the cache (in bytes)
func (*Cache) Set ¶
Set attempts to add the key-value item to the cache. If it returns false, then the Set was dropped and the key-value item isn't added to the cache. If it returns true, there's still a chance it could be dropped by the policy if its determined that the key-value item isn't worth keeping, but otherwise the item will be added and other items will be evicted in order to make room.
The cost of the entry will be evaluated lazily by the cache's Cost function.
func (*Cache) SetCapacity ¶
SetCapacity updates the maxCost of an existing cache.
func (*Cache) SetWithCost ¶
SetWithCost works like Set but adds a key-value pair to the cache with a specific cost. The built-in Cost function will not be called to evaluate the object's cost and instead the given value will be used.
func (*Cache) UsedCapacity ¶
UsedCapacity returns the size of the cache (in bytes)
type Config ¶
type Config struct {
// NumCounters determines the number of counters (keys) to keep that hold
// access frequency information. It's generally a good idea to have more
// counters than the max cache capacity, as this will improve eviction
// accuracy and subsequent hit ratios.
//
// For example, if you expect your cache to hold 1,000,000 items when full,
// NumCounters should be 10,000,000 (10x). Each counter takes up 4 bits, so
// keeping 10,000,000 counters would require 5MB of memory.
NumCounters int64
// MaxCost can be considered as the cache capacity, in whatever units you
// choose to use.
//
// For example, if you want the cache to have a max capacity of 100MB, you
// would set MaxCost to 100,000,000 and pass an item's number of bytes as
// the `cost` parameter for calls to Set. If new items are accepted, the
// eviction process will take care of making room for the new item and not
// overflowing the MaxCost value.
MaxCost int64
// BufferItems determines the size of Get buffers.
//
// Unless you have a rare use case, using `64` as the BufferItems value
// results in good performance.
BufferItems int64
// Metrics determines whether cache statistics are kept during the cache's
// lifetime. There *is* some overhead to keeping statistics, so you should
// only set this flag to true when testing or throughput performance isn't a
// major factor.
Metrics bool
// OnEvict is called for every eviction and passes the hashed key, value,
// and cost to the function.
OnEvict func(item *Item)
// OnReject is called for every rejection done via the policy.
OnReject func(item *Item)
// OnExit is called whenever a value is removed from cache. This can be
// used to do manual memory deallocation. Would also be called on eviction
// and rejection of the value.
OnExit func(val any)
// KeyToHash function is used to customize the key hashing algorithm.
// Each key will be hashed using the provided function. If keyToHash value
// is not set, the default keyToHash function is used.
KeyToHash func(string) (uint64, uint64)
// Cost evaluates a value and outputs a corresponding cost. This function
// is ran after Set is called for a new item or an item update with a cost
// param of 0.
Cost func(value any) int64
// IgnoreInternalCost set to true indicates to the cache that the cost of
// internally storing the value should be ignored. This is useful when the
// cost passed to set is not using bytes as units. Keep in mind that setting
// this to true will increase the memory usage.
IgnoreInternalCost bool
}
Config is passed to NewCache for creating new Cache instances.
type Item ¶
type Item struct {
Key uint64
Conflict uint64
Value any
Cost int64
// contains filtered or unexported fields
}
Item is passed to setBuf so items can eventually be added to the cache.
type Metrics ¶
type Metrics struct {
// contains filtered or unexported fields
}
Metrics is a snapshot of performance statistics for the lifetime of a cache instance.
func (*Metrics) CostAdded ¶
CostAdded is the sum of costs that have been added (successful Set calls).
func (*Metrics) CostEvicted ¶
CostEvicted is the sum of all costs that have been evicted.
func (*Metrics) GetsDropped ¶
GetsDropped is the number of Get counter increments that are dropped internally.
func (*Metrics) Hits ¶
Hits is the number of Get calls where a value was found for the corresponding key.
func (*Metrics) KeysAdded ¶
KeysAdded is the total number of Set calls where a new key-value item was added.
func (*Metrics) KeysEvicted ¶
KeysEvicted is the total number of keys evicted.
func (*Metrics) KeysUpdated ¶
KeysUpdated is the total number of Set calls where the value was updated.
func (*Metrics) Misses ¶
Misses is the number of Get calls where a value was not found for the corresponding key.
func (*Metrics) Ratio ¶
Ratio is the number of Hits over all accesses (Hits + Misses). This is the percentage of successful Get calls.
func (*Metrics) SetsDropped ¶
SetsDropped is the number of Set calls that don't make it into internal buffers (due to contention or some other reason).
func (*Metrics) SetsRejected ¶
SetsRejected is the number of Set calls rejected by the policy (TinyLFU).
Source Files
Directories