com.github.benmanes.caffeine.cache.simulator.policy.irr

Class ClockProPolicy

java.lang.Object

com.github.benmanes.caffeine.cache.simulator.policy.irr.ClockProPolicy

All Implemented Interfaces:

Policy

public final class ClockProPolicy
extends Object
implements Policy

The ClockPro algorithm. This algorithm differs from LIRS by replacing the LRU stacks with Clock (Second Chance) policy. This allows cache hits to be performed concurrently at the cost of a global lock on a miss and a worst case O(n) eviction when the queue is scanned.

ClockPro uses three hands that scan the queue. The hot hand points to the largest recency, the cold hand to the cold entry furthest from the hot hand, and the test hand to the last cold entry in the test period. This policy is adaptive by adjusting the percentage of hot and cold entries that may reside in the cache. It uses non-resident (ghost) entries to retain additional history, which are removed during the test hand's scan. The algorithm is explained by the authors in CLOCK-Pro: An Effective Improvement of the CLOCK Replacement and Clock-Pro: An Effective Replacement in OS Kernel.

This implementation is based on PyClockPro by Sami Lehtinen, available under the MIT license.

Constructor Summary

Constructors

Constructor and Description
ClockProPolicy(com.typesafe.config.Config config)

Method Summary

Modifier and Type	Method and Description
void	finished() Indicates that the recording has completed.
static Set<Policy>	policies(com.typesafe.config.Config config) Returns all variations of this policy based on the configuration parameters.
void	record(long key) Records that the entry was accessed.
PolicyStats	stats() Returns the cache efficiency statistics.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClockProPolicy

public ClockProPolicy(com.typesafe.config.Config config)

Method Detail

policies

public static Set<Policy> policies(com.typesafe.config.Config config)

Returns all variations of this policy based on the configuration parameters.

record

public void record(long key)

Description copied from interface: Policy

Records that the entry was accessed.

Specified by:

record in interface Policy

stats

public PolicyStats stats()

Description copied from interface: Policy

Returns the cache efficiency statistics.

Specified by:

stats in interface Policy

finished

public void finished()

Description copied from interface: Policy

Indicates that the recording has completed.

Specified by:

finished in interface Policy