/*
* JBoss, Home of Professional Open Source
* Copyright 2009 Red Hat Inc. and/or its affiliates and other
* contributors as indicated by the @author tags. All rights reserved.
* See the copyright.txt in the distribution for a full listing of
* individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.infinispan.commands.write;
import java.util.Arrays;
import java.util.Collection;
import java.util.Set;
import java.util.concurrent.locks.LockSupport;
import org.infinispan.commands.Visitor;
import org.infinispan.configuration.cache.Configuration;
import org.infinispan.container.DataContainer;
import org.infinispan.container.entries.InternalCacheEntry;
import org.infinispan.context.Flag;
import org.infinispan.context.InvocationContext;
import org.infinispan.distribution.DataLocality;
import org.infinispan.distribution.DistributionManager;
import org.infinispan.notifications.cachelistener.CacheNotifier;
import org.infinispan.remoting.transport.Address;
import org.infinispan.util.logging.Log;
import org.infinispan.util.logging.LogFactory;
import static java.util.concurrent.TimeUnit.MILLISECONDS;
/**
* Invalidates an entry in a L1 cache (used with DIST mode)
*
* @author Manik Surtani
* @author Mircea.Markus@jboss.com
* @since 4.0
*/
public class InvalidateL1Command extends InvalidateCommand {
public static final int COMMAND_ID = 7;
private static final Log log = LogFactory.getLog(InvalidateL1Command.class);
private DistributionManager dm;
private DataContainer dataContainer;
private Configuration config;
private boolean forRehash;
private Address writeOrigin;
public InvalidateL1Command() {
writeOrigin = null;
}
public InvalidateL1Command(boolean forRehash, DataContainer dc, Configuration config, DistributionManager dm,
CacheNotifier notifier, Set<Flag> flags, Object... keys) {
super(notifier, flags, keys);
writeOrigin = null;
this.dm = dm;
this.forRehash = forRehash;
this.dataContainer = dc;
this.config = config;
}
public InvalidateL1Command(boolean forRehash, DataContainer dc, Configuration config, DistributionManager dm,
CacheNotifier notifier, Set<Flag> flags, Collection<Object> keys) {
this(null, forRehash, dc, config, dm, notifier, flags, keys);
}
public InvalidateL1Command(Address writeOrigin, boolean forRehash, DataContainer dc, Configuration config,
DistributionManager dm, CacheNotifier notifier, Set<Flag> flags, Collection<Object> keys) {
super(notifier, flags, keys);
this.writeOrigin = writeOrigin;
this.dm = dm;
this.forRehash = forRehash;
this.dataContainer = dc;
this.config = config;
}
@Override
public byte getCommandId() {
return COMMAND_ID;
}
public void init(Configuration config, DistributionManager dm, CacheNotifier n, DataContainer dc) {
super.init(n);
this.dm = dm;
this.config = config;
this.dataContainer = dc;
}
@Override
public Object perform(InvocationContext ctx) throws Throwable {
final boolean trace = log.isTraceEnabled();
if (trace) log.tracef("Preparing to invalidate keys %s", Arrays.asList(keys));
for (Object k : getKeys()) {
InternalCacheEntry ice = dataContainer.get(k);
if (ice != null) {
DataLocality locality = dm.getLocality(k);
if (!forRehash) {
while (locality.isUncertain() && dm.isRehashInProgress()) {
LockSupport.parkNanos(MILLISECONDS.toNanos(50));
locality = dm.getLocality(k);
}
}
if (!locality.isLocal()) {
if (forRehash && config.clustering().l1().onRehash()) {
if (trace) log.trace("Not removing, instead entry will be stored in L1");
// don't need to do anything here, DistLockingInterceptor.commitEntry() will put the entry in L1
} else {
if (trace) log.tracef("Invalidating key %s.", k);
invalidate(ctx, k);
}
}
}
}
return null;
}
public void setKeys(Object[] keys) {
this.keys = keys;
}
@Override
public boolean shouldInvoke(InvocationContext ctx) {
if (ctx.isOriginLocal() || forRehash) return true;
for (Object k : getKeys()) {
// If any key in the set of keys to invalidate is not local, or we are uncertain due to a rehash, then we
// process this command.
DataLocality locality = dm.getLocality(k);
if (!locality.isLocal() || locality.isUncertain()) return true;
}
return false;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
if (!super.equals(o)) return false;
InvalidateL1Command that = (InvalidateL1Command) o;
if (forRehash != that.forRehash) return false;
return true;
}
@Override
public Object[] getParameters() {
if (keys == null || keys.length == 0) {
return new Object[]{forRehash, writeOrigin, 0};
} else if (keys.length == 1) {
return new Object[]{forRehash, writeOrigin, 1, keys[0]};
} else {
Object[] retval = new Object[keys.length + 3];
retval[0] = forRehash;
retval[1] = writeOrigin;
retval[2] = keys.length;
System.arraycopy(keys, 0, retval, 3, keys.length);
return retval;
}
}
@Override
public void setParameters(int commandId, Object[] args) {
forRehash = (Boolean) args[0];
writeOrigin = (Address) args[1];
int size = (Integer) args[2];
keys = new Object[size];
if (size == 1) {
keys[0] = args[3];
} else if (size > 0) {
System.arraycopy(args, 3, keys, 0, size);
}
}
@Override
public Object acceptVisitor(InvocationContext ctx, Visitor visitor) throws Throwable {
return visitor.visitInvalidateL1Command(ctx, this);
}
@Override
public int hashCode() {
int result = super.hashCode();
result = 31 * result + (forRehash ? 1 : 0);
return result;
}
@Override
public String toString() {
return getClass().getSimpleName() + "{" +
"num keys=" + (keys == null ? 0 : keys.length) +
", forRehash=" + forRehash +
", origin=" + writeOrigin +
'}';
}
/**
* Returns true if the write that caused the invalidation was performed on this node.
* More formal, if a put(k) happens on node A and ch(A)={B}, then an invalidation message
* might be multicasted by B to all cluster members including A. This method returns true
* if and only if the node where it is invoked is A.
*/
public boolean isCausedByALocalWrite(Address address) {
return writeOrigin != null && writeOrigin.equals(address);
}
}