rizaon commented on code in PR #4518: URL: https://github.com/apache/iceberg/pull/4518#discussion_r976134398
########## core/src/main/java/org/apache/iceberg/io/ContentCache.java: ########## @@ -0,0 +1,310 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.iceberg.io; + +import com.github.benmanes.caffeine.cache.Cache; +import com.github.benmanes.caffeine.cache.Caffeine; +import com.github.benmanes.caffeine.cache.Weigher; +import com.github.benmanes.caffeine.cache.stats.CacheStats; +import java.io.FileNotFoundException; +import java.io.IOException; +import java.nio.ByteBuffer; +import java.time.Duration; +import java.util.List; +import java.util.Map; +import java.util.function.Function; +import org.apache.iceberg.CatalogProperties; +import org.apache.iceberg.exceptions.NotFoundException; +import org.apache.iceberg.exceptions.RuntimeIOException; +import org.apache.iceberg.relocated.com.google.common.base.MoreObjects; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; +import org.apache.iceberg.relocated.com.google.common.collect.Lists; +import org.apache.iceberg.util.PropertyUtil; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class ContentCache { + private static final Logger LOG = LoggerFactory.getLogger(ContentCache.class); + private static final int BUFFER_CHUNK_SIZE = 4 * 1024 * 1024; // 4MB + + public static ContentCache createCache(Map<String, String> properties) { + boolean enabled = + PropertyUtil.propertyAsBoolean( + properties, + CatalogProperties.IO_CACHE_ENABLED, + CatalogProperties.IO_CACHE_ENABLED_DEFAULT); + long durationMs = + PropertyUtil.propertyAsLong( + properties, + CatalogProperties.IO_CACHE_EXPIRATION_INTERVAL_MS, + CatalogProperties.IO_CACHE_EXPIRATION_INTERVAL_MS_DEFAULT); + long totalBytes = + PropertyUtil.propertyAsLong( + properties, + CatalogProperties.IO_CACHE_MAX_TOTAL_BYTES, + CatalogProperties.IO_CACHE_MAX_TOTAL_BYTES_DEFAULT); + long contentLength = + PropertyUtil.propertyAsLong( + properties, + CatalogProperties.IO_CACHE_MAX_CONTENT_LENGTH, + CatalogProperties.IO_CACHE_MAX_CONTENT_LENGTH_DEFAULT); + + if (!enabled) { + LOG.debug("No ContentCache created. {} is false.", CatalogProperties.IO_CACHE_ENABLED); + } else if (durationMs < 0) { + LOG.debug( + "No ContentCache created. {} ({}) is less than 0.", + CatalogProperties.IO_CACHE_EXPIRATION_INTERVAL_MS, + durationMs); + } else if (totalBytes <= 0) { + LOG.debug( + "No ContentCache created. {} ({}) is equal or less than 0.", + CatalogProperties.IO_CACHE_MAX_TOTAL_BYTES, + totalBytes); + } else if (contentLength <= 0) { + LOG.debug( + "No ContentCache created. {} ({}) is equal or less than 0.", + CatalogProperties.IO_CACHE_MAX_CONTENT_LENGTH, + contentLength); + } else { + return new ContentCache(durationMs, totalBytes, contentLength); + } + + return null; + } + + private final long expireAfterAccessMs; + private final long maxTotalBytes; + private final long maxContentLength; + private final Cache<String, CacheEntry> cache; + + public ContentCache(long expireAfterAccessMs, long maxTotalBytes, long maxContentLength) { + this.expireAfterAccessMs = expireAfterAccessMs; + this.maxTotalBytes = maxTotalBytes; + this.maxContentLength = maxContentLength; + + Caffeine<Object, Object> builder = Caffeine.newBuilder(); + if (expireAfterAccessMs > 0) { + builder = builder.expireAfterAccess(Duration.ofMillis(expireAfterAccessMs)); + } + + this.cache = + builder + .maximumWeight(maxTotalBytes) + .weigher( + (Weigher<String, CacheEntry>) + (key, value) -> (int) Math.min(value.length, Integer.MAX_VALUE)) + .recordStats() + .build(); + } + + public long expireAfterAccess() { + return expireAfterAccessMs; + } + + public long maxContentLength() { + return maxContentLength; + } + + public long maxTotalBytes() { + return maxTotalBytes; + } + + public CacheStats stats() { + return cache.stats(); + } + + public CacheEntry get(String key, Function<String, CacheEntry> mappingFunction) { + return cache.get(key, mappingFunction); + } + + public CacheEntry getIfPresent(String location) { + return cache.getIfPresent(location); + } + + public InputFile tryCache(FileIO io, String location, long length) { + if (length <= maxContentLength) { + return new CachingInputFile(this, io, location, length); + } + return io.newInputFile(location, length); + } + + public void invalidate(String key) { + cache.invalidate(key); + } + + public void invalidateAll() { + cache.invalidateAll(); + } + + public void cleanUp() { + cache.cleanUp(); + } + + public long estimatedCacheSize() { + return cache.estimatedSize(); + } + + @Override + public String toString() { + return MoreObjects.toStringHelper(this) + .add("expireAfterAccessMs", expireAfterAccessMs) + .add("maxContentLength", maxContentLength) + .add("maxTotalBytes", maxTotalBytes) + .add("cacheStats", cache.stats()) + .toString(); + } + + private static class CacheEntry { + private final long length; + private final List<ByteBuffer> buffers; + + private CacheEntry(long length, List<ByteBuffer> buffers) { + this.length = length; + this.buffers = buffers; + } + } + + private static class CachingInputFile implements InputFile { + private final ContentCache contentCache; + private final FileIO io; + private final String location; + private final long length; + private InputFile fallbackInputFile = null; + + private CachingInputFile(ContentCache cache, FileIO io, String location, long length) { + this.contentCache = cache; + this.io = io; + this.location = location; + this.length = length; + } + + private InputFile wrappedInputFile() { + if (fallbackInputFile == null) { + fallbackInputFile = io.newInputFile(location, length); + } + return fallbackInputFile; + } + + @Override + public long getLength() { + CacheEntry buf = contentCache.getIfPresent(location); + if (buf != null) { + return buf.length; + } else if (fallbackInputFile != null) { + return fallbackInputFile.getLength(); + } else { + return length; + } + } + + /** + * Opens a new {@link SeekableInputStream} for the underlying data file, either through cache or + * through the inner FileIO. + * + * <p>If data file is not cached yet, and it can fit in the cache, the file content will be + * cached first before returning a {@link ByteBufferInputStream}. Otherwise, return a new + * SeekableInputStream from the inner FIleIO. + * + * @return a {@link ByteBufferInputStream} if file exist in the cache or can fit in the cache. + * Otherwise, return a new SeekableInputStream from the inner FIleIO. + */ + @Override + public SeekableInputStream newStream() { + try { + // read-through cache if file length is less than or equal to maximum length allowed to + // cache. + if (getLength() <= contentCache.maxContentLength()) { + return cachedStream(); + } + + // fallback to non-caching input stream. + return wrappedInputFile().newStream(); + } catch (FileNotFoundException e) { + throw new NotFoundException( + e, "Failed to open input stream for file %s: %s", location, e.toString()); + } catch (IOException e) { + throw new RuntimeIOException( Review Comment: Done. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For additional commands, e-mail: issues-h...@iceberg.apache.org
