Abyss-lord commented on code in PR #7200: URL: https://github.com/apache/gravitino/pull/7200#discussion_r2103631644
########## core/src/main/java/org/apache/gravitino/cache/CaffeineEntityCache.java: ########## @@ -0,0 +1,458 @@ +/* + * 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.gravitino.cache; + +import com.github.benmanes.caffeine.cache.Cache; +import com.github.benmanes.caffeine.cache.Caffeine; +import com.github.benmanes.caffeine.cache.RemovalCause; +import com.google.common.annotations.VisibleForTesting; +import com.google.common.base.Preconditions; +import com.google.common.collect.Lists; +import com.googlecode.concurrenttrees.radix.ConcurrentRadixTree; +import com.googlecode.concurrenttrees.radix.RadixTree; +import com.googlecode.concurrenttrees.radix.node.concrete.DefaultCharArrayNodeFactory; +import java.io.IOException; +import java.util.List; +import java.util.Optional; +import java.util.concurrent.ArrayBlockingQueue; +import java.util.concurrent.ThreadPoolExecutor; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.locks.ReentrantLock; +import java.util.function.Supplier; +import org.apache.gravitino.Entity; +import org.apache.gravitino.EntityStore; +import org.apache.gravitino.HasIdentifier; +import org.apache.gravitino.NameIdentifier; +import org.apache.gravitino.SupportsRelationOperations; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** This class implements a meta cache using Caffeine cache. */ +public class CaffeineEntityCache extends BaseEntityCache { + private static final Logger LOG = LoggerFactory.getLogger(CaffeineEntityCache.class.getName()); + + /** Singleton instance */ + private static volatile CaffeineEntityCache INSTANCE = null; + + /** Cache part */ + private final Cache<EntityCacheKey, List<Entity>> cacheData; + + /** Index part */ + private RadixTree<EntityCacheKey> cacheIndex; + + private final ReentrantLock opLock = new ReentrantLock(); + + @VisibleForTesting + public static void resetForTest() { + INSTANCE = null; + } + + /** + * Returns the instance of MetaCacheCaffeine based on the cache configuration and entity store. + * + * @param cacheConfig The cache configuration + * @param entityStore The entity store to load entities from the database + * @return The instance of {@link CaffeineEntityCache} + */ + public static CaffeineEntityCache getInstance(CacheConfig cacheConfig, EntityStore entityStore) { + if (INSTANCE == null) { + synchronized (CaffeineEntityCache.class) { + if (INSTANCE == null) { + INSTANCE = new CaffeineEntityCache(cacheConfig, entityStore); + } + } + } + return INSTANCE; + } + + /** + * Returns the instance of MetaCacheCaffeine, if it is initialized, otherwise throws an exception. + * + * @return If INSTANCE initialized, returns the instance, otherwise throws an exception. + */ + public static CaffeineEntityCache getInstance() { + if (INSTANCE == null) { + throw new RuntimeException("Illegal state: instance not initialized"); + } + + return INSTANCE; + } + + /** + * Constructs a new MetaCacheCaffeine. + * + * @param cacheConfig the cache configuration + * @param entityStore The entity store to load entities from the database + */ + private CaffeineEntityCache(CacheConfig cacheConfig, EntityStore entityStore) { + super(cacheConfig, entityStore); + cacheIndex = new ConcurrentRadixTree<>(new DefaultCharArrayNodeFactory()); + + /** + * Executor for async cache cleanup, when a cache expires then use this executor to sync other + * cache and index trees + */ + ThreadPoolExecutor cleanupExec = + new ThreadPoolExecutor( + 1, + 1, + 0L, + TimeUnit.MILLISECONDS, + new ArrayBlockingQueue<>(100), + r -> { + Thread t = new Thread(r, "CaffeineMetaCache-Cleanup"); + t.setDaemon(true); + return t; + }, + new ThreadPoolExecutor.CallerRunsPolicy()); + + Caffeine<EntityCacheKey, List<Entity>> cacheDataBuilder = newBaseBuilder(cacheConfig); + + cacheDataBuilder + .executor(cleanupExec) + .removalListener( + (key, value, cause) -> { + if (cause != RemovalCause.EXPIRED) { + return; + } + try { + invalidateExpiredItem(key); + } catch (Throwable t) { + LOG.error("Async removal failed for {}", value, t); + } + }); + + this.cacheData = cacheDataBuilder.build(); + } + + /** {@inheritDoc} */ + @Override + public <E extends Entity & HasIdentifier> List<E> getOrLoad( + NameIdentifier ident, Entity.EntityType type, SupportsRelationOperations.Type relType) + throws IOException { + Preconditions.checkArgument(ident != null, "NameIdentifier cannot be null"); + Preconditions.checkArgument(type != null, "EntityType cannot be null"); + Preconditions.checkArgument(relType != null, "SupportsRelationOperations.Type cannot be null"); + + return withLockAndThrow( + () -> { + EntityCacheKey entityCacheKey = EntityCacheKey.of(ident, type, relType); + List<Entity> entitiesFromCache = cacheData.getIfPresent(entityCacheKey); + + if (entitiesFromCache != null) { + return convertSafe(entitiesFromCache); + } + + List<E> entities = entityStore.listEntitiesByRelation(relType, ident, type); + syncEntitiesToCache(entityCacheKey, toEntityList(entities)); + + return entities; + }); + } + + /** {@inheritDoc} */ + @Override + public <E extends Entity & HasIdentifier> E getOrLoad( + NameIdentifier ident, Entity.EntityType type) throws IOException { + Preconditions.checkArgument(ident != null, "NameIdentifier cannot be null"); + Preconditions.checkArgument(type != null, "EntityType cannot be null"); + + return withLockAndThrow( + () -> { + EntityCacheKey entityCacheKey = EntityCacheKey.of(ident, type); + List<Entity> entitiesFromCache = cacheData.getIfPresent(entityCacheKey); + + if (entitiesFromCache != null) { + return convertSafe(entitiesFromCache.get(0)); + } + + E entityFromDb = entityStore.get(ident, type, getEntityClass(type)); Review Comment: Fix -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
