-
Notifications
You must be signed in to change notification settings - Fork 19
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Refactor chunk cache #443
Draft
ivanyu
wants to merge
1
commit into
main
Choose a base branch
from
ivanyu/refactor-cache
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Refactor chunk cache #443
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
131 changes: 131 additions & 0 deletions
131
core/src/main/java/io/aiven/kafka/tieredstorage/chunkmanager/cache/AbstractChunkCache.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,131 @@ | ||
/* | ||
* Copyright 2023 Aiven Oy | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package io.aiven.kafka.tieredstorage.chunkmanager.cache; | ||
|
||
import java.io.IOException; | ||
import java.io.InputStream; | ||
import java.util.concurrent.CompletableFuture; | ||
import java.util.concurrent.CompletionException; | ||
import java.util.concurrent.ExecutionException; | ||
import java.util.concurrent.Executor; | ||
import java.util.concurrent.ForkJoinPool; | ||
import java.util.concurrent.TimeUnit; | ||
import java.util.concurrent.TimeoutException; | ||
import java.util.concurrent.atomic.AtomicReference; | ||
import java.util.function.Supplier; | ||
|
||
import io.aiven.kafka.tieredstorage.chunkmanager.ChunkKey; | ||
import io.aiven.kafka.tieredstorage.metrics.CaffeineStatsCounter; | ||
|
||
import com.github.benmanes.caffeine.cache.AsyncCache; | ||
import com.github.benmanes.caffeine.cache.Caffeine; | ||
import com.github.benmanes.caffeine.cache.RemovalListener; | ||
import com.github.benmanes.caffeine.cache.Scheduler; | ||
import com.github.benmanes.caffeine.cache.Weigher; | ||
|
||
public abstract class AbstractChunkCache<T> extends BaseChunkCache<T> { | ||
private static final long GET_TIMEOUT_SEC = 10; | ||
private static final String METRIC_GROUP = "chunk-cache"; | ||
|
||
private final Executor executor = new ForkJoinPool(); | ||
|
||
private final CaffeineStatsCounter statsCounter = new CaffeineStatsCounter(METRIC_GROUP); | ||
|
||
protected AsyncCache<ChunkKey, T> cache; | ||
|
||
/** | ||
* Get a chunk from the cache. | ||
* | ||
* <p>If the chunk is not present in the cache, use {@literal chunkSupplier} to get it and cache. | ||
* | ||
* <p>Since it's not possible to cache an opened InputStream, the actual data is cached, and everytime | ||
* there is a call to cache the InputStream is recreated from the data stored in cache and stored into local | ||
* variable. This also allows solving the race condition between eviction and fetching. Since the InputStream is | ||
* opened right when fetching from cache happens even if the actual value is removed from the cache, | ||
* the InputStream will still contain the data. | ||
*/ | ||
@Override | ||
protected InputStream getChunk0(final ChunkKey chunkKey, | ||
final Supplier<CompletableFuture<InputStream>> chunkSupplier) | ||
throws ExecutionException, InterruptedException, TimeoutException { | ||
final AtomicReference<InputStream> result = new AtomicReference<>(); | ||
return cache.asMap() | ||
.compute(chunkKey, (key, val) -> { | ||
if (val == null) { | ||
statsCounter.recordMiss(); | ||
// TODO do not put a failed future into the cache | ||
return chunkSupplier.get().thenApplyAsync(chunk -> { | ||
try { | ||
final T t = this.cacheChunk(chunkKey, chunk); | ||
result.getAndSet(cachedChunkToInputStream(t)); | ||
return t; | ||
} catch (final IOException e) { | ||
throw new CompletionException(e); | ||
} | ||
}, executor); | ||
} else { | ||
statsCounter.recordHit(); | ||
return CompletableFuture.supplyAsync(() -> { | ||
try { | ||
final T cachedChunk = val.get(); | ||
result.getAndSet(cachedChunkToInputStream(cachedChunk)); | ||
return cachedChunk; | ||
} catch (final InterruptedException | ExecutionException e) { | ||
throw new CompletionException(e); | ||
} | ||
}, executor); | ||
} | ||
}) | ||
.thenApplyAsync(t -> result.get()) | ||
.get(GET_TIMEOUT_SEC, TimeUnit.SECONDS); | ||
} | ||
|
||
public void supplyIfAbsent(final ChunkKey chunkKey, | ||
final Supplier<CompletableFuture<InputStream>> chunkSupplier) { | ||
// TODO do some logging if error | ||
// TODO do not put a failed future into the cache | ||
Comment on lines
+99
to
+100
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These are pre-existing problems, decided not to handle them in this PR |
||
cache.asMap().computeIfAbsent(chunkKey, | ||
key -> chunkSupplier.get().thenApplyAsync(chunk -> { | ||
try { | ||
return this.cacheChunk(chunkKey, chunk); | ||
} catch (final IOException e) { | ||
throw new CompletionException(e); | ||
} | ||
}, executor)); | ||
} | ||
|
||
public abstract InputStream cachedChunkToInputStream(final T cachedChunk); | ||
|
||
public abstract T cacheChunk(final ChunkKey chunkKey, final InputStream chunk) throws IOException; | ||
|
||
public abstract RemovalListener<ChunkKey, T> removalListener(); | ||
|
||
public abstract Weigher<ChunkKey, T> weigher(); | ||
|
||
protected AsyncCache<ChunkKey, T> buildCache(final ChunkCacheConfig config) { | ||
final Caffeine<Object, Object> cacheBuilder = Caffeine.newBuilder(); | ||
config.cacheSize().ifPresent(maximumWeight -> cacheBuilder.maximumWeight(maximumWeight).weigher(weigher())); | ||
config.cacheRetention().ifPresent(cacheBuilder::expireAfterAccess); | ||
final var cache = cacheBuilder.evictionListener(removalListener()) | ||
.scheduler(Scheduler.systemScheduler()) | ||
.executor(executor) | ||
.recordStats(() -> statsCounter) | ||
.buildAsync(); | ||
statsCounter.registerSizeMetric(cache.synchronous()::estimatedSize); | ||
return cache; | ||
} | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a pre-existing problem, decided not to handle it in this PR