Skip to content

Commit

Permalink
wip
Browse files Browse the repository at this point in the history
  • Loading branch information
ben-manes committed Jan 16, 2025
1 parent 9b65365 commit 3be2a51
Show file tree
Hide file tree
Showing 5 changed files with 73 additions and 52 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -1523,6 +1523,14 @@ void setAccessTime(Node<K, V> node, long now) {
}
}

/** Returns if the entry's write time would exceed the minimum expiration reorder threshold. */
boolean exceedsWriteTimeTolerance(Node<K, V> node, long varTime, long now) {
return (expiresAfterWrite() && (now - node.getWriteTime()) > EXPIRE_WRITE_TOLERANCE)
|| (expiresVariable()
&& Math.abs(varTime - node.getVariableTime()) > EXPIRE_WRITE_TOLERANCE)
|| (refreshAfterWrite() && refreshes().containsKey(node.getKeyReference()));
}

/**
* Performs the post-processing work required after a write.
*
Expand Down Expand Up @@ -2298,8 +2306,8 @@ public void putAll(Map<? extends K, ? extends V> map) {
if (node == null) {
node = nodeFactory.newNode(key, keyReferenceQueue(),
value, valueReferenceQueue(), newWeight, now);
setVariableTime(node, expireAfterCreate(key, value, expiry, now));
long expirationTime = isComputingAsync(value) ? (now + ASYNC_EXPIRY) : now;
setVariableTime(node, expireAfterCreate(key, value, expiry, now));
setAccessTime(node, expirationTime);
setWriteTime(node, expirationTime);
}
Expand Down Expand Up @@ -2384,11 +2392,10 @@ public void putAll(Map<? extends K, ? extends V> map) {

long expirationTime = isComputingAsync(value) ? (now + ASYNC_EXPIRY) : now;
if (mayUpdate) {
exceedsTolerance =
(expiresAfterWrite() && (now - prior.getWriteTime()) > EXPIRE_WRITE_TOLERANCE)
|| (expiresVariable()
&& Math.abs(varTime - prior.getVariableTime()) > EXPIRE_WRITE_TOLERANCE);
setWriteTime(prior, expirationTime);
exceedsTolerance = exceedsWriteTimeTolerance(prior, varTime, now);
if (expired || exceedsTolerance) {
setWriteTime(prior, isComputingAsync(value) ? (now + ASYNC_EXPIRY) : now);
}

prior.setValue(value, valueReferenceQueue());
prior.setWeight(newWeight);
Expand Down Expand Up @@ -2514,8 +2521,9 @@ public boolean remove(Object key, Object value) {
requireNonNull(key);
requireNonNull(value);

long[] now = new long[1];
var now = new long[1];
var oldWeight = new int[1];
var exceedsTolerance = new boolean[1];
@SuppressWarnings({"unchecked", "Varifier"})
@Nullable K[] nodeKey = (K[]) new Object[1];
@SuppressWarnings({"unchecked", "Varifier"})
Expand All @@ -2538,8 +2546,11 @@ public boolean remove(Object key, Object value) {
n.setWeight(weight);

long expirationTime = isComputingAsync(value) ? (now[0] + ASYNC_EXPIRY) : now[0];
exceedsTolerance[0] = exceedsWriteTimeTolerance(n, varTime, expirationTime);
if (exceedsTolerance[0]) {
setWriteTime(n, expirationTime);
}
setAccessTime(n, expirationTime);
setWriteTime(n, expirationTime);
setVariableTime(n, varTime);

discardRefresh(k);
Expand All @@ -2552,7 +2563,7 @@ public boolean remove(Object key, Object value) {
}

int weightedDifference = (weight - oldWeight[0]);
if (expiresAfterWrite() || (weightedDifference != 0)) {
if (exceedsTolerance[0] || (weightedDifference != 0)) {
afterWrite(new UpdateTask(node, weightedDifference));
} else {
afterRead(node, now[0], /* recordHit= */ false);
Expand All @@ -2573,13 +2584,15 @@ public boolean replace(K key, V oldValue, V newValue, boolean shouldDiscardRefre
requireNonNull(oldValue);
requireNonNull(newValue);

int weight = weigher.weigh(key, newValue);
var now = new long[1];
var oldWeight = new int[1];
var exceedsTolerance = new boolean[1];
@SuppressWarnings({"unchecked", "Varifier"})
@Nullable K[] nodeKey = (K[]) new Object[1];
@SuppressWarnings({"unchecked", "Varifier"})
@Nullable V[] prevValue = (V[]) new Object[1];
int[] oldWeight = new int[1];
long[] now = new long[1];

int weight = weigher.weigh(key, newValue);
Node<K, V> node = data.computeIfPresent(nodeFactory.newLookupKey(key), (k, n) -> {
synchronized (n) {
requireIsAlive(key, n);
Expand All @@ -2597,8 +2610,11 @@ public boolean replace(K key, V oldValue, V newValue, boolean shouldDiscardRefre
n.setWeight(weight);

long expirationTime = isComputingAsync(newValue) ? (now[0] + ASYNC_EXPIRY) : now[0];
exceedsTolerance[0] = exceedsWriteTimeTolerance(n, varTime, expirationTime);
if (exceedsTolerance[0]) {
setWriteTime(n, expirationTime);
}
setAccessTime(n, expirationTime);
setWriteTime(n, expirationTime);
setVariableTime(n, varTime);

if (shouldDiscardRefresh) {
Expand All @@ -2613,7 +2629,7 @@ public boolean replace(K key, V oldValue, V newValue, boolean shouldDiscardRefre
}

int weightedDifference = (weight - oldWeight[0]);
if (expiresAfterWrite() || (weightedDifference != 0)) {
if (exceedsTolerance[0] || (weightedDifference != 0)) {
afterWrite(new UpdateTask(node, weightedDifference));
} else {
afterRead(node, now[0], /* recordHit= */ false);
Expand Down Expand Up @@ -2688,8 +2704,8 @@ public void replaceAll(BiFunction<? super K, ? super V, ? extends V> function) {
weight[1] = weigher.weigh(key, newValue[0]);
var created = nodeFactory.newNode(key, keyReferenceQueue(),
newValue[0], valueReferenceQueue(), weight[1], now[0]);
setVariableTime(created, expireAfterCreate(key, newValue[0], expiry(), now[0]));
long expirationTime = isComputingAsync(newValue[0]) ? (now[0] + ASYNC_EXPIRY) : now[0];
setVariableTime(created, expireAfterCreate(key, newValue[0], expiry(), now[0]));
setAccessTime(created, expirationTime);
setWriteTime(created, expirationTime);
return created;
Expand Down Expand Up @@ -2724,15 +2740,11 @@ public void replaceAll(BiFunction<? super K, ? super V, ? extends V> function) {
n.setValue(newValue[0], valueReferenceQueue());
n.setWeight(weight[1]);

long expirationTime = isComputingAsync(newValue[0]) ? (now[0] + ASYNC_EXPIRY) : now[0];
setAccessTime(n, expirationTime);
setWriteTime(n, expirationTime);
setVariableTime(n, varTime);
if (isComputingAsync(newValue[0])) {
long expirationTime = now[0] + ASYNC_EXPIRY;
setAccessTime(n, expirationTime);
setWriteTime(n, expirationTime);
} else {
setAccessTime(n, now[0]);
setWriteTime(n, now[0]);
}

discardRefresh(k);
return n;
}
Expand Down Expand Up @@ -2853,6 +2865,7 @@ public void replaceAll(BiFunction<? super K, ? super V, ? extends V> function) {

var weight = new int[2]; // old, new
var cause = new RemovalCause[1];
var exceedsTolerance = new boolean[1];

Node<K, V> node = data.compute(keyRef, (kr, n) -> {
if (n == null) {
Expand Down Expand Up @@ -2925,8 +2938,11 @@ public void replaceAll(BiFunction<? super K, ? super V, ? extends V> function) {
n.setWeight(weight[1]);

long expirationTime = isComputingAsync(newValue[0]) ? (now[0] + ASYNC_EXPIRY) : now[0];
exceedsTolerance[0] = exceedsWriteTimeTolerance(n, varTime, expirationTime);
if (cause[0].wasEvicted() || exceedsTolerance[0]) {
setWriteTime(n, expirationTime);
}
setAccessTime(n, expirationTime);
setWriteTime(n, expirationTime);
setVariableTime(n, varTime);

discardRefresh(kr);
Expand Down Expand Up @@ -2954,7 +2970,7 @@ public void replaceAll(BiFunction<? super K, ? super V, ? extends V> function) {
afterWrite(new AddTask(node, weight[1]));
} else {
int weightedDifference = weight[1] - weight[0];
if (expiresAfterWrite() || (weightedDifference != 0)) {
if (exceedsTolerance[0] || (weightedDifference != 0)) {
afterWrite(new UpdateTask(node, weightedDifference));
} else {
afterRead(node, now[0], /* recordHit= */ false);
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[versions]
caffeine = "3.1.8"
junit = "5.11.4"
reactor = "3.7.1"
reactor = "3.7.2"
truth = "1.4.4"
versions = "0.51.0"

Expand Down
2 changes: 1 addition & 1 deletion gradle/libs.versions.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ auto-value = "1.11.0"
awaitility = "4.2.2"
bcel = "6.10.0"
bnd = "7.1.0"
bouncycastle-jdk18on = "1.79"
bouncycastle-jdk18on = "1.80"
cache2k = "2.6.1.Final"
caffeine = "3.1.8"
checkstyle = "10.21.1"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import static com.google.common.truth.Truth.assertThat;
import static java.util.Arrays.asList;
import static java.util.concurrent.TimeUnit.MILLISECONDS;
import static java.util.concurrent.TimeUnit.SECONDS;

import java.util.List;
import java.util.Set;
Expand Down Expand Up @@ -317,97 +318,99 @@ public void testExpirationOrder_access() {
assertThat(keySet).containsExactly(0, 1, 2, 5, 7, 9);
}

// Note: Caffeine skips TTL updates for writes to the same entry within a small tolerance
public void testExpirationOrder_write() throws ExecutionException {
// test lru within a single segment
FakeTicker ticker = new FakeTicker();
IdentityLoader<Integer> loader = identityLoader();
LoadingCache<Integer, Integer> cache = CaffeinatedGuava.build(Caffeine.newBuilder()
.expireAfterWrite(11, MILLISECONDS)
.expireAfterWrite(11, SECONDS)
.ticker(ticker::read),
loader);
for (int i = 0; i < 10; i++) {
cache.getUnchecked(i);
ticker.advance(1, MILLISECONDS);
ticker.advance(1, SECONDS);
}
Set<Integer> keySet = cache.asMap().keySet();
assertThat(keySet).containsExactly(0, 1, 2, 3, 4, 5, 6, 7, 8, 9);

// 0 expires
ticker.advance(1, MILLISECONDS);
ticker.advance(1, SECONDS);
assertThat(keySet).containsExactly(1, 2, 3, 4, 5, 6, 7, 8, 9);

// get doesn't stop 1 from expiring
getAll(cache, asList(0, 1, 2));
CacheTesting.drainRecencyQueues(cache);
ticker.advance(1, MILLISECONDS);
ticker.advance(1, SECONDS);
assertThat(keySet).containsExactly(2, 3, 4, 5, 6, 7, 8, 9, 0);

// get(K, Callable) doesn't stop 2 from expiring
cache.get(2, Callables.returning(-2));
CacheTesting.drainRecencyQueues(cache);
ticker.advance(1, MILLISECONDS);
ticker.advance(1, SECONDS);
assertThat(keySet).containsExactly(3, 4, 5, 6, 7, 8, 9, 0);

// asMap.put saves 3
cache.asMap().put(3, -3);
ticker.advance(1, MILLISECONDS);
ticker.advance(1, SECONDS);
assertThat(keySet).containsExactly(4, 5, 6, 7, 8, 9, 0, 3);

// asMap.replace saves 4
cache.asMap().replace(4, -4);
ticker.advance(1, MILLISECONDS);
ticker.advance(1, SECONDS);
assertThat(keySet).containsExactly(5, 6, 7, 8, 9, 0, 3, 4);

// 5 expires
ticker.advance(1, MILLISECONDS);
ticker.advance(1, SECONDS);
assertThat(keySet).containsExactly(6, 7, 8, 9, 0, 3, 4);
}

// Note: Caffeine skips TTL updates for writes to the same entry within a small tolerance
public void testExpirationOrder_writeAccess() throws ExecutionException {
// test lru within a single segment
FakeTicker ticker = new FakeTicker();
IdentityLoader<Integer> loader = identityLoader();
LoadingCache<Integer, Integer> cache = CaffeinatedGuava.build(Caffeine.newBuilder()
.expireAfterWrite(5, MILLISECONDS)
.expireAfterAccess(3, MILLISECONDS)
.expireAfterWrite(5, SECONDS)
.expireAfterAccess(3, SECONDS)
.ticker(ticker::read),
loader);
for (int i = 0; i < 5; i++) {
cache.getUnchecked(i);
}
ticker.advance(1, MILLISECONDS);
ticker.advance(1, SECONDS);
for (int i = 5; i < 10; i++) {
cache.getUnchecked(i);
}
ticker.advance(1, MILLISECONDS);
ticker.advance(1, SECONDS);

Set<Integer> keySet = cache.asMap().keySet();
assertThat(keySet).containsExactly(0, 1, 2, 3, 4, 5, 6, 7, 8, 9);

// get saves 1, 3; 0, 2, 4 expire
getAll(cache, asList(1, 3));
CacheTesting.drainRecencyQueues(cache);
ticker.advance(1, MILLISECONDS);
ticker.advance(1, SECONDS);
assertThat(keySet).containsExactly(5, 6, 7, 8, 9, 1, 3);

// get saves 6, 8; 5, 7, 9 expire
getAll(cache, asList(6, 8));
CacheTesting.drainRecencyQueues(cache);
ticker.advance(1, MILLISECONDS);
ticker.advance(1, SECONDS);
assertThat(keySet).containsExactly(1, 3, 6, 8);

// get fails to save 1, put saves 3
cache.asMap().put(3, -3);
getAll(cache, asList(1));
CacheTesting.drainRecencyQueues(cache);
ticker.advance(1, MILLISECONDS);
ticker.advance(1, SECONDS);
assertThat(keySet).containsExactly(6, 8, 3);

// get(K, Callable) fails to save 8, replace saves 6
cache.asMap().replace(6, -6);
cache.get(8, Callables.returning(-8));
CacheTesting.drainRecencyQueues(cache);
ticker.advance(1, MILLISECONDS);
ticker.advance(1, SECONDS);
assertThat(keySet).containsExactly(3, 6);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
package com.github.benmanes.caffeine.guava.compatibility;

import static com.github.benmanes.caffeine.guava.compatibility.TestingCacheLoaders.incrementingLoader;
import static java.util.concurrent.TimeUnit.MILLISECONDS;
import static java.util.concurrent.TimeUnit.SECONDS;

import com.github.benmanes.caffeine.cache.Caffeine;
import com.github.benmanes.caffeine.guava.CaffeinatedGuava;
Expand All @@ -33,12 +33,14 @@
*/
@SuppressWarnings("PreferJavaTimeOverload")
public class CacheRefreshTest extends TestCase {

// Note: Caffeine skips TTL updates for writes to the same entry within a small tolerance
public void testAutoRefresh() {
FakeTicker ticker = new FakeTicker();
IncrementingLoader loader = incrementingLoader();
LoadingCache<Integer, Integer> cache = CaffeinatedGuava.build(Caffeine.newBuilder()
.refreshAfterWrite(3, MILLISECONDS)
.expireAfterWrite(6, MILLISECONDS)
.refreshAfterWrite(3, SECONDS)
.expireAfterWrite(6, SECONDS)
.executor(MoreExecutors.directExecutor())
.ticker(ticker::read), loader);
int expectedLoads = 0;
Expand All @@ -48,7 +50,7 @@ public void testAutoRefresh() {
expectedLoads++;
assertEquals(expectedLoads, loader.getLoadCount());
assertEquals(expectedReloads, loader.getReloadCount());
ticker.advance(1, MILLISECONDS);
ticker.advance(1, SECONDS);
}

assertEquals(Integer.valueOf(0), cache.getUnchecked(0));
Expand All @@ -58,7 +60,7 @@ public void testAutoRefresh() {
assertEquals(expectedReloads, loader.getReloadCount());

// refresh 0
ticker.advance(1, MILLISECONDS);
ticker.advance(1, SECONDS);
cache.getUnchecked(0); // Allow refresh to return old value while refreshing
assertEquals(Integer.valueOf(1), cache.getUnchecked(0));
expectedReloads++;
Expand All @@ -69,15 +71,15 @@ public void testAutoRefresh() {

// write to 1 to delay its refresh
cache.asMap().put(1, -1);
ticker.advance(1, MILLISECONDS);
ticker.advance(1, SECONDS);
assertEquals(Integer.valueOf(1), cache.getUnchecked(0));
assertEquals(Integer.valueOf(-1), cache.getUnchecked(1));
assertEquals(Integer.valueOf(2), cache.getUnchecked(2));
assertEquals(expectedLoads, loader.getLoadCount());
assertEquals(expectedReloads, loader.getReloadCount());

// refresh 2
ticker.advance(1, MILLISECONDS);
ticker.advance(1, SECONDS);
cache.getUnchecked(2); // Allow refresh to return old value while refreshing
assertEquals(Integer.valueOf(1), cache.getUnchecked(0));
assertEquals(Integer.valueOf(-1), cache.getUnchecked(1));
Expand All @@ -86,15 +88,15 @@ public void testAutoRefresh() {
assertEquals(expectedLoads, loader.getLoadCount());
assertEquals(expectedReloads, loader.getReloadCount());

ticker.advance(1, MILLISECONDS);
ticker.advance(1, SECONDS);
assertEquals(Integer.valueOf(1), cache.getUnchecked(0));
assertEquals(Integer.valueOf(-1), cache.getUnchecked(1));
assertEquals(Integer.valueOf(3), cache.getUnchecked(2));
assertEquals(expectedLoads, loader.getLoadCount());
assertEquals(expectedReloads, loader.getReloadCount());

// refresh 0 and 1
ticker.advance(1, MILLISECONDS);
ticker.advance(1, SECONDS);
cache.getUnchecked(0); // Allow refresh to return old value while refreshing
cache.getUnchecked(1); // Allow refresh to return old value while refreshing
assertEquals(Integer.valueOf(2), cache.getUnchecked(0));
Expand Down

0 comments on commit 3be2a51

Please sign in to comment.