/*
* JBoss, Home of Professional Open Source
* Copyright 2011 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.interceptors.locking;
import org.infinispan.CacheException;
import org.infinispan.commands.tx.VersionedPrepareCommand;
import org.infinispan.commands.write.WriteCommand;
import org.infinispan.config.Configuration;
import org.infinispan.container.DataContainer;
import org.infinispan.container.entries.CacheEntry;
import org.infinispan.container.entries.ClusteredRepeatableReadEntry;
import org.infinispan.container.versioning.EntryVersion;
import org.infinispan.container.versioning.EntryVersionsMap;
import org.infinispan.container.versioning.IncrementableEntryVersion;
import org.infinispan.container.versioning.VersionGenerator;
import org.infinispan.context.impl.TxInvocationContext;
import org.infinispan.distribution.DistributionManager;
import org.infinispan.factories.annotations.Inject;
import org.infinispan.remoting.rpc.RpcManager;
import org.infinispan.remoting.transport.Address;
import org.infinispan.transaction.xa.CacheTransaction;
import org.infinispan.util.logging.Log;
import org.infinispan.util.logging.LogFactory;
import java.util.Collection;
import java.util.List;
/**
* Abstractization for logic related to different clustering modes: replicated or distributed. This implements the <a
* href="http://en.wikipedia.org/wiki/Bridge_pattern">Bridge</a> pattern as described by the GoF: this plays the role of
* the <b>Implementor</b> and various LockingInterceptors are the <b>Abstraction</b>.
*
* @author Mircea Markus
* @since 5.1
*/
public interface ClusteringDependentLogic {
static final Log log = LogFactory.getLog(ClusteringDependentLogic.class);
boolean localNodeIsOwner(Object key);
boolean localNodeIsPrimaryOwner(Object key);
void commitEntry(CacheEntry entry, EntryVersion newVersion, boolean skipOwnershipCheck);
Collection<Address> getOwners(Collection<Object> keys);
EntryVersionsMap createNewVersionsAndCheckForWriteSkews(VersionGenerator versionGenerator, TxInvocationContext context, VersionedPrepareCommand prepareCommand);
/**
* This logic is used when a changing a key affects all the nodes in the cluster, e.g. int the replicated,
* invalidated and local cache modes.
*/
public static final class AllNodesLogic implements ClusteringDependentLogic {
private DataContainer dataContainer;
private RpcManager rpcManager;
@Inject
public void init(DataContainer dc, RpcManager rpcManager) {
this.dataContainer = dc;
this.rpcManager = rpcManager;
}
@Override
public boolean localNodeIsOwner(Object key) {
return true;
}
@Override
public boolean localNodeIsPrimaryOwner(Object key) {
return rpcManager == null || rpcManager.getTransport().isCoordinator();
}
@Override
public void commitEntry(CacheEntry entry, EntryVersion newVersion, boolean skipOwnershipCheck) {
entry.commit(dataContainer, newVersion);
}
@Override
public Collection<Address> getOwners(Collection<Object> keys) {
return null;
}
@Override
public EntryVersionsMap createNewVersionsAndCheckForWriteSkews(VersionGenerator versionGenerator, TxInvocationContext context, VersionedPrepareCommand prepareCommand) {
// In REPL mode, this happens if we are the coordinator.
if (rpcManager.getTransport().isCoordinator()) {
// Perform a write skew check on each entry.
EntryVersionsMap uv = new EntryVersionsMap();
for (WriteCommand c : prepareCommand.getModifications()) {
for (Object k : c.getAffectedKeys()) {
ClusteredRepeatableReadEntry entry = (ClusteredRepeatableReadEntry) context.lookupEntry(k);
if (entry.performWriteSkewCheck(dataContainer)) {
IncrementableEntryVersion newVersion = entry.isCreated() ? versionGenerator.generateNew() : versionGenerator.increment((IncrementableEntryVersion) entry.getVersion());
uv.put(k, newVersion);
} else {
// Write skew check detected!
throw new CacheException("Write skew detected on key " + k + " for transaction " + context.getTransaction());
}
}
}
context.getCacheTransaction().setUpdatedEntryVersions(uv);
return uv;
}
return null;
}
}
public static final class DistributionLogic implements ClusteringDependentLogic {
private DistributionManager dm;
private DataContainer dataContainer;
private Configuration configuration;
private RpcManager rpcManager;
@Inject
public void init(DistributionManager dm, DataContainer dataContainer, Configuration configuration, RpcManager rpcManager) {
this.dm = dm;
this.dataContainer = dataContainer;
this.configuration = configuration;
this.rpcManager = rpcManager;
}
@Override
public boolean localNodeIsOwner(Object key) {
return dm.getLocality(key).isLocal();
}
@Override
public boolean localNodeIsPrimaryOwner(Object key) {
final List<Address> locate = dm.locate(key);
final Address address = rpcManager.getAddress();
final boolean result = locate.get(0).equals(address);
log.tracef("Node owners are %s and my address is %s. Am I main owner? - %b", locate, address, result);
return result;
}
@Override
public void commitEntry(CacheEntry entry, EntryVersion newVersion, boolean skipOwnershipCheck) {
boolean doCommit = true;
// ignore locality for removals, even if skipOwnershipCheck is not true
if (!skipOwnershipCheck && !entry.isRemoved() && !localNodeIsOwner(entry.getKey())) {
if (configuration.isL1CacheEnabled()) {
dm.transformForL1(entry);
} else {
doCommit = false;
}
}
if (doCommit)
entry.commit(dataContainer, newVersion);
else
entry.rollback();
}
@Override
public Collection<Address> getOwners(Collection<Object> keys) {
return dm.getAffectedNodes(keys);
}
@Override
public EntryVersionsMap createNewVersionsAndCheckForWriteSkews(VersionGenerator versionGenerator, TxInvocationContext context, VersionedPrepareCommand prepareCommand) {
// Perform a write skew check on mapped entries.
EntryVersionsMap uv = new EntryVersionsMap();
for (WriteCommand c : prepareCommand.getModifications()) {
for (Object k : c.getAffectedKeys()) {
if (localNodeIsPrimaryOwner(k)) {
ClusteredRepeatableReadEntry entry = (ClusteredRepeatableReadEntry) context.lookupEntry(k);
if (!context.isOriginLocal()) {
// What version did the transaction originator see??
EntryVersion versionSeen = prepareCommand.getVersionsSeen().get(k);
if (versionSeen != null) entry.setVersion(versionSeen);
}
if (entry.performWriteSkewCheck(dataContainer)) {
IncrementableEntryVersion newVersion = entry.isCreated() ? versionGenerator.generateNew() : versionGenerator.increment((IncrementableEntryVersion) entry.getVersion());
uv.put(k, newVersion);
} else {
// Write skew check detected!
throw new CacheException("Write skew detected on key " + k + " for transaction " + context.getTransaction());
}
}
}
}
CacheTransaction cacheTransaction = context.getCacheTransaction();
EntryVersionsMap uvOld = cacheTransaction.getUpdatedEntryVersions();
if (uvOld != null && !uvOld.isEmpty()) {
uvOld.putAll(uv);
uv = uvOld;
}
cacheTransaction.setUpdatedEntryVersions(uv);
return (uv.isEmpty()) ? null : uv;
}
}
}