package org.infinispan.interceptors;
import org.infinispan.commands.FlagAffectedCommand;
import org.infinispan.commands.LocalFlagAffectedCommand;
import org.infinispan.commands.read.EntrySetCommand;
import org.infinispan.commands.read.GetKeyValueCommand;
import org.infinispan.commands.read.KeySetCommand;
import org.infinispan.commands.read.SizeCommand;
import org.infinispan.commands.read.ValuesCommand;
import org.infinispan.commands.write.ApplyDeltaCommand;
import org.infinispan.commands.write.InvalidateCommand;
import org.infinispan.commands.write.PutKeyValueCommand;
import org.infinispan.commands.write.RemoveCommand;
import org.infinispan.commands.write.ReplaceCommand;
import org.infinispan.commons.util.InfinispanCollections;
import org.infinispan.container.DataContainer;
import org.infinispan.container.EntryFactory;
import org.infinispan.container.InternalEntryFactory;
import org.infinispan.container.entries.CacheEntry;
import org.infinispan.container.entries.InternalCacheEntry;
import org.infinispan.context.Flag;
import org.infinispan.context.InvocationContext;
import org.infinispan.factories.annotations.Inject;
import org.infinispan.interceptors.base.JmxStatsCommandInterceptor;
import org.infinispan.jmx.annotations.DisplayType;
import org.infinispan.jmx.annotations.MBean;
import org.infinispan.jmx.annotations.ManagedAttribute;
import org.infinispan.jmx.annotations.ManagedOperation;
import org.infinispan.jmx.annotations.MeasurementType;
import org.infinispan.jmx.annotations.Parameter;
import org.infinispan.metadata.impl.InternalMetadataImpl;
import org.infinispan.persistence.CollectionKeyFilter;
import org.infinispan.persistence.manager.PersistenceManager;
import org.infinispan.persistence.spi.AdvancedCacheLoader;
import org.infinispan.marshall.core.MarshalledEntry;
import org.infinispan.metadata.InternalMetadata;
import org.infinispan.metadata.Metadata;
import org.infinispan.metadata.Metadatas;
import org.infinispan.notifications.cachelistener.CacheNotifier;
import org.infinispan.util.TimeService;
import org.infinispan.util.concurrent.ConcurrentHashSet;
import org.infinispan.util.logging.Log;
import org.infinispan.util.logging.LogFactory;
import java.util.Collection;
import java.util.Collections;
import java.util.Set;
import java.util.concurrent.ConcurrentLinkedQueue;
import java.util.concurrent.atomic.AtomicLong;
import java.util.concurrent.atomic.AtomicReference;
@MBean(objectName = "CacheLoader", description = "Component that handles loading entries from a CacheStore into memory.")
public class CacheLoaderInterceptor extends JmxStatsCommandInterceptor {
private final AtomicLong cacheLoads = new AtomicLong(0);
private final AtomicLong cacheMisses = new AtomicLong(0);
protected PersistenceManager persistenceManager;
protected CacheNotifier notifier;
protected volatile boolean enabled = true;
protected EntryFactory entryFactory;
private TimeService timeService;
private InternalEntryFactory iceFactory;
private DataContainer dataContainer;
private static final Log log = LogFactory.getLog(CacheLoaderInterceptor.class);
@Override
protected Log getLog() {
return log;
}
@Inject
protected void injectDependencies(PersistenceManager clm, EntryFactory entryFactory, CacheNotifier notifier,
TimeService timeService, InternalEntryFactory iceFactory, DataContainer dataContainer) {
this.persistenceManager = clm;
this.notifier = notifier;
this.entryFactory = entryFactory;
this.timeService = timeService;
this.iceFactory = iceFactory;
this.dataContainer = dataContainer;
}
@Override
public Object visitApplyDeltaCommand(InvocationContext ctx, ApplyDeltaCommand command) throws Throwable {
if (enabled) {
Object key;
if ((key = command.getKey()) != null) {
loadIfNeeded(ctx, key, false, command);
}
}
return invokeNextInterceptor(ctx, command);
}
@Override
public Object visitPutKeyValueCommand(InvocationContext ctx, PutKeyValueCommand command) throws Throwable {
if (enabled) {
Object key;
if ((key = command.getKey()) != null) {
loadIfNeeded(ctx, key, false, command);
}
}
return invokeNextInterceptor(ctx, command);
}
@Override
public Object visitGetKeyValueCommand(InvocationContext ctx, GetKeyValueCommand command) throws Throwable {
if (enabled) {
Object key;
if ((key = command.getKey()) != null) {
loadIfNeededAndUpdateStats(ctx, key, true, command);
}
}
return invokeNextInterceptor(ctx, command);
}
@Override
public Object visitInvalidateCommand(InvocationContext ctx, InvalidateCommand command) throws Throwable {
if (enabled) {
Object[] keys;
if ((keys = command.getKeys()) != null && keys.length > 0) {
for (Object key : command.getKeys()) {
loadIfNeeded(ctx, key, false, command);
}
}
}
return invokeNextInterceptor(ctx, command);
}
@Override
public Object visitRemoveCommand(InvocationContext ctx, RemoveCommand command) throws Throwable {
if (enabled) {
Object key;
if ((key = command.getKey()) != null) {
loadIfNeededAndUpdateStats(ctx, key, false, command);
}
}
return invokeNextInterceptor(ctx, command);
}
@Override
public Object visitReplaceCommand(InvocationContext ctx, ReplaceCommand command) throws Throwable {
if (enabled) {
Object key;
if ((key = command.getKey()) != null) {
loadIfNeededAndUpdateStats(ctx, key, false, command);
}
}
return invokeNextInterceptor(ctx, command);
}
@Override
public Object visitSizeCommand(InvocationContext ctx, SizeCommand command) throws Throwable {
int totalSize = 0;
if (enabled && !shouldSkipCacheLoader(command)) {
totalSize = persistenceManager.size();
}
// Passivation stores evicted entries so we want to add those or if the loader didn't have anything or was skipped
// we should at least return the in memory size
// This assumes that when passivation is not enabled that the cache store holds a superset of the data container
if (cacheConfiguration.persistence().passivation() || totalSize == 0) {
totalSize += (Integer)super.visitSizeCommand(ctx, command);
}
return totalSize;
}
@Override
public Object visitKeySetCommand(InvocationContext ctx, KeySetCommand command) throws Throwable {
Object keys = super.visitKeySetCommand(ctx, command);
if (enabled && !shouldSkipCacheLoader(command)) {
Set<Object> keysSet = (Set<Object>) keys;
final ConcurrentHashSet<Object> union = new ConcurrentHashSet<Object>();
for (Object k : keysSet)
union.add(k);
persistenceManager.processOnAllStores(new CollectionKeyFilter(union), new AdvancedCacheLoader.CacheLoaderTask() {
@Override
public void processEntry(MarshalledEntry marshalledEntry, AdvancedCacheLoader.TaskContext taskContext) throws InterruptedException {
union.add(marshalledEntry.getKey());
}
}, false, false);
return Collections.unmodifiableSet(union);
}
return keys;
}
@Override
public Object visitEntrySetCommand(InvocationContext ctx, EntrySetCommand command) throws Throwable {
Object entrySet = super.visitEntrySetCommand(ctx, command);
if (enabled && !shouldSkipCacheLoader(command)) {
final ConcurrentHashSet<InternalCacheEntry> union = new ConcurrentHashSet<InternalCacheEntry>();
final ConcurrentHashSet<Object> processedKeys = new ConcurrentHashSet<Object>();
for (InternalCacheEntry ice : (Set<InternalCacheEntry>)entrySet)
processedKeys.add(ice.getKey());
persistenceManager.processOnAllStores(new CollectionKeyFilter(processedKeys), new AdvancedCacheLoader.CacheLoaderTask() {
@Override
public void processEntry(MarshalledEntry marshalledEntry, AdvancedCacheLoader.TaskContext taskContext) throws InterruptedException {
union.add(iceFactory.create(marshalledEntry.getKey(), marshalledEntry.getValue(), marshalledEntry.getMetadata()));
}
}, true, true);
for (InternalCacheEntry ice : (Set<InternalCacheEntry>) entrySet)
union.add(ice);
return Collections.unmodifiableSet(union);
}
return entrySet;
}
@Override
public Object visitValuesCommand(InvocationContext ctx, ValuesCommand command) throws Throwable {
Object values = super.visitValuesCommand(ctx, command);
if (enabled && !shouldSkipCacheLoader(command)) {
final ConcurrentLinkedQueue<Object> result = new ConcurrentLinkedQueue<Object>();
persistenceManager.processOnAllStores(null, new AdvancedCacheLoader.CacheLoaderTask() {
@Override
public void processEntry(MarshalledEntry marshalledEntry, AdvancedCacheLoader.TaskContext taskContext) throws InterruptedException {
result.add(marshalledEntry.getValue());
}
}, true, false);
result.addAll((Collection<Object>)values);
return result;
}
return values;
}
protected boolean forceLoad(Object key, Set<Flag> flags) {
return false;
}
/**
* Indicates whether the operation is a delta write. If it is, the
* previous value needs to be loaded from the cache store so that
* it can be merged.
*/
protected boolean isDeltaWrite(Set<Flag> flags) {
return flags != null && flags.contains(Flag.DELTA_WRITE);
}
private boolean shouldSkipCacheLoader(LocalFlagAffectedCommand cmd) {
return cmd.hasFlag(Flag.SKIP_CACHE_STORE) || cmd.hasFlag(Flag.SKIP_CACHE_LOAD);
}
protected boolean canLoad(Object key) {
return true;
}
/**
* Loads from the cache loader the entry for the given key. A found value is loaded into the current context. The
* method returns whether the value was found or not, or even if the cache loader was checked.
* @param ctx The current invocation's context
* @param key The key for the entry to look up
* @param isRetrieval Whether or not this was called in the scope of a get
* @param cmd The command that was called that now wants to query the cache loader
* @return Whether or not the entry was found in the cache loader. A value of null means the cache loader was never
* queried for the value, so it was neither a hit or a miss.
* @throws Throwable
*/
protected final Boolean loadIfNeeded(final InvocationContext ctx, Object key, boolean isRetrieval, final FlagAffectedCommand cmd) throws Throwable {
if (shouldSkipCacheLoader(cmd) || cmd.hasFlag(Flag.IGNORE_RETURN_VALUES) || !canLoad(key)) {
return null; //skip operation
}
// If this is a remote call, skip loading UNLESS we are the primary data owner of this key, and
// are using eviction or write skew checking.
if (!isRetrieval && !ctx.isOriginLocal() && !forceLoad(key, cmd.getFlags())) return null;
// first check if the container contains the key we need. Try and load this into the context.
CacheEntry e = ctx.lookupEntry(key);
if (!shouldAttemptLookup(e)) {
return null;
}
final boolean isDelta = cmd instanceof ApplyDeltaCommand;
final AtomicReference<Boolean> isLoaded = new AtomicReference<Boolean>();
dataContainer.compute(key, new DataContainer.ComputeAction() {
@Override
public InternalCacheEntry compute(Object key, InternalCacheEntry oldEntry,
InternalEntryFactory factory) {
//under the lock, check if the entry exists in the DataContainer
if (oldEntry != null) {
wrapInternalCacheEntry(ctx, key, cmd, oldEntry, isDelta);
isLoaded.set(null); //not loaded
return oldEntry; //no changes in container
}
MarshalledEntry loaded = internalLoadAndUpdateStats(key, ctx);
if(loaded == null) {
isLoaded.set(Boolean.FALSE); //not loaded
return null; //no changed in container
}
InternalCacheEntry newEntry;
InternalMetadata metadata = loaded.getMetadata();
if (metadata != null) {
Metadata actual = metadata instanceof InternalMetadataImpl ? ((InternalMetadataImpl) metadata).actual() :
metadata;
newEntry = factory.create(loaded.getKey(), loaded.getValue(), actual, metadata.created(), metadata.lifespan(),
metadata.lastUsed(), metadata.maxIdle());
} else {
//metadata is null!
newEntry = factory.create(loaded.getKey(), loaded.getValue(), (Metadata) null);
}
CacheEntry wrappedEntry = wrapInternalCacheEntry(ctx, key, cmd, newEntry, isDelta);
recordLoadedEntry(ctx, key, wrappedEntry, newEntry, cmd);
//afterSuccessfullyLoaded(wrappedEntry);
isLoaded.set(Boolean.TRUE); //loaded!
return newEntry;
}
});
return isLoaded.get();
}
private MarshalledEntry internalLoadAndUpdateStats(Object key, InvocationContext context) {
final MarshalledEntry loaded = persistenceManager.loadFromAllStores(key, context);
if (getLog().isTraceEnabled()) {
getLog().tracef("Loaded %s for key %s from persistence.", loaded, key);
}
if(loaded == null) {
return null;
}
InternalMetadata metadata = loaded.getMetadata();
if (metadata != null && metadata.isExpired(timeService.wallClockTime())) {
return null;
}
return loaded;
}
private CacheEntry wrapInternalCacheEntry(InvocationContext ctx, Object key, FlagAffectedCommand cmd,
InternalCacheEntry ice, boolean isDelta) {
if (isDelta) {
ctx.putLookedUpEntry(key, ice);
return entryFactory.wrapEntryForDelta(ctx, key, ((ApplyDeltaCommand) cmd).getDelta());
} else {
return entryFactory.wrapEntryForPut(ctx, key, ice, false, cmd, false);
}
}
/**
* Only perform if context doesn't have a value found (Read Committed) or if we can do a remote
* get only if the value is null (Repeatable Read)
*/
private boolean shouldAttemptLookup(CacheEntry e) {
return e == null || (e.isNull() || e.getValue() == null) && !e.skipLookup();
}
/**
* This method records a loaded entry, performing the following steps: <ol> <li>Increments counters for reporting via
* JMX</li> <li>updates the 'entry' reference (an entry in the current thread's InvocationContext) with the contents
* of 'loadedEntry' (freshly loaded from the CacheStore) so that the loaded details will be flushed to the
* DataContainer when the call returns (in the LockingInterceptor, when locks are released)</li> <li>Notifies
* listeners</li> </ol>
*/
private void recordLoadedEntry(InvocationContext ctx, Object key,
CacheEntry entry, InternalCacheEntry loadedEntry, FlagAffectedCommand cmd) {
boolean entryExists = loadedEntry != null;
if (log.isTraceEnabled()) {
log.trace("Entry exists in loader? " + entryExists);
}
if (getStatisticsEnabled()) {
if (entryExists) {
cacheLoads.incrementAndGet();
} else {
cacheMisses.incrementAndGet();
}
}
if (entryExists) {
final Object value = loadedEntry.getValue();
// FIXME: There's no point to trigger the entryLoaded/Activated event twice.
sendNotification(key, value, true, ctx, cmd);
entry.setValue(value);
Metadata metadata = cmd.getMetadata();
Metadata loadedMetadata = loadedEntry.getMetadata();
if (metadata != null && loadedMetadata != null)
metadata = Metadatas.applyVersion(loadedMetadata, metadata);
else if (metadata == null)
metadata = loadedMetadata;
entry.setMetadata(metadata);
// TODO shouldn't we also be setting last used and created timestamps?
entry.setValid(true);
sendNotification(key, value, false, ctx, cmd);
}
}
protected void sendNotification(Object key, Object value, boolean pre,
InvocationContext ctx, FlagAffectedCommand cmd) {
notifier.notifyCacheEntryLoaded(key, value, pre, ctx, cmd);
}
private void loadIfNeededAndUpdateStats(InvocationContext ctx, Object key, boolean isRetrieval, FlagAffectedCommand cmd) throws Throwable {
Boolean found = loadIfNeeded(ctx, key, isRetrieval, cmd);
if (found == Boolean.FALSE && getStatisticsEnabled()) {
cacheMisses.incrementAndGet();
}
}
@ManagedAttribute(
description = "Number of entries loaded from cache store",
displayName = "Number of cache store loads",
measurementType = MeasurementType.TRENDSUP
)
@SuppressWarnings("unused")
public long getCacheLoaderLoads() {
return cacheLoads.get();
}
@ManagedAttribute(
description = "Number of entries that did not exist in cache store",
displayName = "Number of cache store load misses",
measurementType = MeasurementType.TRENDSUP
)
@SuppressWarnings("unused")
public long getCacheLoaderMisses() {
return cacheMisses.get();
}
@Override
@ManagedOperation(
description = "Resets statistics gathered by this component",
displayName = "Reset Statistics"
)
public void resetStatistics() {
cacheLoads.set(0);
cacheMisses.set(0);
}
@ManagedAttribute(
description = "Returns a collection of cache loader types which are configured and enabled",
displayName = "Returns a collection of cache loader types which are configured and enabled",
displayType = DisplayType.DETAIL)
/**
* This method returns a collection of cache loader types (fully qualified class names) that are configured and enabled.
*/
public Collection<String> getStores() {
if (enabled && cacheConfiguration.persistence().usingStores()) {
return persistenceManager.getStoresAsString();
} else {
return InfinispanCollections.emptySet();
}
}
@ManagedOperation(
description = "Disable all stores of a given type, where type is a fully qualified class name of the cache loader to disable",
displayName = "Disable all stores of a given type"
)
@SuppressWarnings("unused")
/**
* Disables a store of a given type.
*
* If the given type cannot be found, this is a no-op. If more than one store of the same type is configured,
* all stores of the given type are disabled.
*
* @param storeType fully qualified class name of the cache loader type to disable
*/
public void disableStore(@Parameter(name = "storeType", description = "Fully qualified class name of a store implementation") String storeType) {
if (enabled) persistenceManager.disableStore(storeType);
}
public void disableInterceptor() {
enabled = false;
}
}