X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-distributed-datastore%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fdatastore%2FTransactionProxy.java;h=c3a5d074140785626828c0d6eebaf18709ed5bbc;hb=1280c1ce40241738edd5ebae40bf5dfddec68198;hp=388dd9f4bda2fee3e82bba4660a137876cf9dbda;hpb=dbff1740fe3e5a1f007c183ecc27d25915866945;p=controller.git
diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionProxy.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionProxy.java
index 388dd9f4bd..c3a5d07414 100644
--- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionProxy.java
+++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionProxy.java
@@ -5,16 +5,14 @@
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
-
package org.opendaylight.controller.cluster.datastore;
import akka.actor.ActorSelection;
-import akka.dispatch.Mapper;
-import akka.dispatch.OnComplete;
import com.google.common.annotations.VisibleForTesting;
+import com.google.common.base.Function;
import com.google.common.base.Optional;
import com.google.common.base.Preconditions;
-import com.google.common.collect.Lists;
+import com.google.common.collect.Iterables;
import com.google.common.util.concurrent.CheckedFuture;
import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.ListenableFuture;
@@ -24,18 +22,9 @@ import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
+import java.util.Map.Entry;
import java.util.Set;
-import java.util.concurrent.ExecutionException;
-import java.util.concurrent.Semaphore;
-import java.util.concurrent.TimeUnit;
-import java.util.concurrent.atomic.AtomicBoolean;
-import java.util.concurrent.atomic.AtomicLong;
-import javax.annotation.concurrent.GuardedBy;
-import org.opendaylight.controller.cluster.datastore.compat.PreLithiumTransactionContextImpl;
-import org.opendaylight.controller.cluster.datastore.exceptions.NoShardLeaderException;
import org.opendaylight.controller.cluster.datastore.identifiers.TransactionIdentifier;
-import org.opendaylight.controller.cluster.datastore.messages.CreateTransaction;
-import org.opendaylight.controller.cluster.datastore.messages.CreateTransactionReply;
import org.opendaylight.controller.cluster.datastore.shardstrategy.ShardStrategyFactory;
import org.opendaylight.controller.cluster.datastore.utils.ActorContext;
import org.opendaylight.controller.cluster.datastore.utils.NormalizedNodeAggregator;
@@ -45,287 +34,131 @@ import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadWriteTransactio
import org.opendaylight.yangtools.util.concurrent.MappingCheckedFuture;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
-import org.opendaylight.yangtools.yang.model.api.SchemaContext;
+import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import scala.concurrent.Future;
import scala.concurrent.Promise;
-import scala.concurrent.duration.FiniteDuration;
/**
- * TransactionProxy acts as a proxy for one or more transactions that were created on a remote shard
- *
- * Creating a transaction on the consumer side will create one instance of a transaction proxy. If during
- * the transaction reads and writes are done on data that belongs to different shards then a separate transaction will
- * be created on each of those shards by the TransactionProxy
- *
- *
- * The TransactionProxy does not make any guarantees about atomicity or order in which the transactions on the various
- * shards will be executed.
- *
+ * A transaction potentially spanning multiple backend shards.
*/
public class TransactionProxy extends AbstractDOMStoreTransaction implements DOMStoreReadWriteTransaction {
-
- public static enum TransactionType {
- READ_ONLY,
- WRITE_ONLY,
- READ_WRITE;
-
- // Cache all values
- private static final TransactionType[] VALUES = values();
-
- public static TransactionType fromInt(final int type) {
- try {
- return VALUES[type];
- } catch (IndexOutOfBoundsException e) {
- throw new IllegalArgumentException("In TransactionType enum value " + type, e);
- }
- }
- }
-
private static enum TransactionState {
OPEN,
READY,
CLOSED,
}
-
- static final Mapper SAME_FAILURE_TRANSFORMER =
- new Mapper() {
- @Override
- public Throwable apply(Throwable failure) {
- return failure;
- }
- };
-
- private static final AtomicLong counter = new AtomicLong();
-
private static final Logger LOG = LoggerFactory.getLogger(TransactionProxy.class);
- /**
- * Time interval in between transaction create retries.
- */
- private static final FiniteDuration CREATE_TX_TRY_INTERVAL =
- FiniteDuration.create(1, TimeUnit.SECONDS);
-
- /**
- * Stores the remote Tx actors for each requested data store path to be used by the
- * PhantomReference to close the remote Tx's. This is only used for read-only Tx's. The
- * remoteTransactionActorsMB volatile serves as a memory barrier to publish updates to the
- * remoteTransactionActors list so they will be visible to the thread accessing the
- * PhantomReference.
- */
- List remoteTransactionActors;
- volatile AtomicBoolean remoteTransactionActorsMB;
-
- /**
- * Stores the create transaction results per shard.
- */
- private final Map txFutureCallbackMap = new HashMap<>();
-
- private final TransactionType transactionType;
- final ActorContext actorContext;
- private final String transactionChainId;
- private final SchemaContext schemaContext;
+ private final Map txContextWrappers = new HashMap<>();
+ private final AbstractTransactionContextFactory> txContextFactory;
+ private final TransactionType type;
private TransactionState state = TransactionState.OPEN;
- private volatile boolean initialized;
- private Semaphore operationLimiter;
- private OperationCompleter operationCompleter;
-
- public TransactionProxy(ActorContext actorContext, TransactionType transactionType) {
- this(actorContext, transactionType, "");
- }
+ @VisibleForTesting
+ public TransactionProxy(final AbstractTransactionContextFactory> txContextFactory, final TransactionType type) {
+ super(txContextFactory.nextIdentifier(), txContextFactory.getActorContext().getDatastoreContext()
+ .isTransactionDebugContextEnabled());
+ this.txContextFactory = txContextFactory;
+ this.type = Preconditions.checkNotNull(type);
- public TransactionProxy(ActorContext actorContext, TransactionType transactionType, String transactionChainId) {
- super(createIdentifier(actorContext));
- this.actorContext = Preconditions.checkNotNull(actorContext,
- "actorContext should not be null");
- this.transactionType = Preconditions.checkNotNull(transactionType,
- "transactionType should not be null");
- this.schemaContext = Preconditions.checkNotNull(actorContext.getSchemaContext(),
- "schemaContext should not be null");
- this.transactionChainId = transactionChainId;
-
- LOG.debug("Created txn {} of type {} on chain {}", getIdentifier(), transactionType, transactionChainId);
+ LOG.debug("New {} Tx - {}", type, getIdentifier());
}
- private static TransactionIdentifier createIdentifier(ActorContext actorContext) {
- String memberName = actorContext.getCurrentMemberName();
- if (memberName == null) {
- memberName = "UNKNOWN-MEMBER";
- }
+ @Override
+ public CheckedFuture exists(final YangInstanceIdentifier path) {
+ Preconditions.checkState(type != TransactionType.WRITE_ONLY, "Reads from write-only transactions are not allowed");
- return new TransactionIdentifier(memberName, counter.getAndIncrement());
- }
+ LOG.debug("Tx {} exists {}", getIdentifier(), path);
- @VisibleForTesting
- boolean hasTransactionContext() {
- for(TransactionFutureCallback txFutureCallback : txFutureCallbackMap.values()) {
- TransactionContext transactionContext = txFutureCallback.getTransactionContext();
- if(transactionContext != null) {
- return true;
+ final SettableFuture proxyFuture = SettableFuture.create();
+ TransactionContextWrapper contextWrapper = getContextWrapper(path);
+ contextWrapper.maybeExecuteTransactionOperation(new TransactionOperation() {
+ @Override
+ public void invoke(TransactionContext transactionContext) {
+ transactionContext.dataExists(path, proxyFuture);
}
- }
-
- return false;
- }
+ });
- private boolean isRootPath(YangInstanceIdentifier path){
- return !path.getPathArguments().iterator().hasNext();
+ return MappingCheckedFuture.create(proxyFuture, ReadFailedException.MAPPER);
}
@Override
public CheckedFuture>, ReadFailedException> read(final YangInstanceIdentifier path) {
-
- Preconditions.checkState(transactionType != TransactionType.WRITE_ONLY,
- "Read operation on write-only transaction is not allowed");
+ Preconditions.checkState(type != TransactionType.WRITE_ONLY, "Reads from write-only transactions are not allowed");
LOG.debug("Tx {} read {}", getIdentifier(), path);
- final SettableFuture>> proxyFuture = SettableFuture.create();
-
- if(isRootPath(path)){
- readAllData(path, proxyFuture);
+ if (YangInstanceIdentifier.EMPTY.equals(path)) {
+ return readAllData();
} else {
- throttleOperation();
-
- TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path);
- txFutureCallback.enqueueTransactionOperation(new TransactionOperation() {
- @Override
- public void invoke(TransactionContext transactionContext) {
- transactionContext.readData(path, proxyFuture);
- }
- });
-
+ return singleShardRead(shardNameFromIdentifier(path), path);
}
-
- return MappingCheckedFuture.create(proxyFuture, ReadFailedException.MAPPER);
}
- private void readAllData(final YangInstanceIdentifier path,
- final SettableFuture>> proxyFuture) {
- Set allShardNames = actorContext.getConfiguration().getAllShardNames();
- List>>> futures = new ArrayList<>(allShardNames.size());
-
- for(String shardName : allShardNames){
- final SettableFuture>> subProxyFuture = SettableFuture.create();
-
- throttleOperation();
-
- TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(shardName);
- txFutureCallback.enqueueTransactionOperation(new TransactionOperation() {
- @Override
- public void invoke(TransactionContext transactionContext) {
- transactionContext.readData(path, subProxyFuture);
- }
- });
-
- futures.add(subProxyFuture);
- }
-
- final ListenableFuture>>> future = Futures.allAsList(futures);
-
- future.addListener(new Runnable() {
- @Override
- public void run() {
- try {
- proxyFuture.set(NormalizedNodeAggregator.aggregate(YangInstanceIdentifier.builder().build(),
- future.get(), actorContext.getSchemaContext()));
- } catch (InterruptedException | ExecutionException e) {
- proxyFuture.setException(e);
- }
- }
- }, actorContext.getActorSystem().dispatcher());
- }
-
- @Override
- public CheckedFuture exists(final YangInstanceIdentifier path) {
-
- Preconditions.checkState(transactionType != TransactionType.WRITE_ONLY,
- "Exists operation on write-only transaction is not allowed");
-
- LOG.debug("Tx {} exists {}", getIdentifier(), path);
-
- throttleOperation();
-
- final SettableFuture proxyFuture = SettableFuture.create();
-
- TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path);
- txFutureCallback.enqueueTransactionOperation(new TransactionOperation() {
+ private CheckedFuture>, ReadFailedException> singleShardRead(
+ final String shardName, final YangInstanceIdentifier path) {
+ final SettableFuture>> proxyFuture = SettableFuture.create();
+ TransactionContextWrapper contextWrapper = getContextWrapper(shardName);
+ contextWrapper.maybeExecuteTransactionOperation(new TransactionOperation() {
@Override
public void invoke(TransactionContext transactionContext) {
- transactionContext.dataExists(path, proxyFuture);
+ transactionContext.readData(path, proxyFuture);
}
});
return MappingCheckedFuture.create(proxyFuture, ReadFailedException.MAPPER);
}
- private void checkModificationState() {
- Preconditions.checkState(transactionType != TransactionType.READ_ONLY,
- "Modification operation on read-only transaction is not allowed");
- Preconditions.checkState(state == TransactionState.OPEN,
- "Transaction is sealed - further modifications are not allowed");
- }
-
- private void throttleOperation() {
- throttleOperation(1);
- }
-
- private void throttleOperation(int acquirePermits) {
- if(!initialized) {
- // Note : Currently mailbox-capacity comes from akka.conf and not from the config-subsystem
- operationLimiter = new Semaphore(actorContext.getTransactionOutstandingOperationLimit());
- operationCompleter = new OperationCompleter(operationLimiter);
+ private CheckedFuture>, ReadFailedException> readAllData() {
+ final Set allShardNames = txContextFactory.getActorContext().getConfiguration().getAllShardNames();
+ final Collection>, ReadFailedException>> futures = new ArrayList<>(allShardNames.size());
- // Make sure we write this last because it's volatile and will also publish the non-volatile writes
- // above as well so they'll be visible to other threads.
- initialized = true;
+ for (String shardName : allShardNames) {
+ futures.add(singleShardRead(shardName, YangInstanceIdentifier.EMPTY));
}
- try {
- if(!operationLimiter.tryAcquire(acquirePermits,
- actorContext.getDatastoreContext().getOperationTimeoutInSeconds(), TimeUnit.SECONDS)){
- LOG.warn("Failed to acquire operation permit for transaction {}", getIdentifier());
- }
- } catch (InterruptedException e) {
- if(LOG.isDebugEnabled()) {
- LOG.debug("Interrupted when trying to acquire operation permit for transaction " + getIdentifier().toString(), e);
- } else {
- LOG.warn("Interrupted when trying to acquire operation permit for transaction {}", getIdentifier());
+ final ListenableFuture>>> listFuture = Futures.allAsList(futures);
+ final ListenableFuture>> aggregateFuture;
+
+ aggregateFuture = Futures.transform(listFuture, new Function>>, Optional>>() {
+ @Override
+ public Optional> apply(final List>> input) {
+ try {
+ return NormalizedNodeAggregator.aggregate(YangInstanceIdentifier.EMPTY, input, txContextFactory.getActorContext().getSchemaContext());
+ } catch (DataValidationFailedException e) {
+ throw new IllegalArgumentException("Failed to aggregate", e);
+ }
}
- }
+ });
+
+ return MappingCheckedFuture.create(aggregateFuture, ReadFailedException.MAPPER);
}
@Override
- public void write(final YangInstanceIdentifier path, final NormalizedNode, ?> data) {
-
+ public void delete(final YangInstanceIdentifier path) {
checkModificationState();
- LOG.debug("Tx {} write {}", getIdentifier(), path);
-
- throttleOperation();
+ LOG.debug("Tx {} delete {}", getIdentifier(), path);
- TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path);
- txFutureCallback.enqueueTransactionOperation(new TransactionOperation() {
+ TransactionContextWrapper contextWrapper = getContextWrapper(path);
+ contextWrapper.maybeExecuteTransactionOperation(new TransactionOperation() {
@Override
public void invoke(TransactionContext transactionContext) {
- transactionContext.writeData(path, data);
+ transactionContext.deleteData(path);
}
});
}
@Override
public void merge(final YangInstanceIdentifier path, final NormalizedNode, ?> data) {
-
checkModificationState();
LOG.debug("Tx {} merge {}", getIdentifier(), path);
- throttleOperation();
-
- TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path);
- txFutureCallback.enqueueTransactionOperation(new TransactionOperation() {
+ TransactionContextWrapper contextWrapper = getContextWrapper(path);
+ contextWrapper.maybeExecuteTransactionOperation(new TransactionOperation() {
@Override
public void invoke(TransactionContext transactionContext) {
transactionContext.mergeData(path, data);
@@ -334,23 +167,27 @@ public class TransactionProxy extends AbstractDOMStoreTransaction data) {
checkModificationState();
- LOG.debug("Tx {} delete {}", getIdentifier(), path);
-
- throttleOperation();
+ LOG.debug("Tx {} write {}", getIdentifier(), path);
- TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path);
- txFutureCallback.enqueueTransactionOperation(new TransactionOperation() {
+ TransactionContextWrapper contextWrapper = getContextWrapper(path);
+ contextWrapper.maybeExecuteTransactionOperation(new TransactionOperation() {
@Override
public void invoke(TransactionContext transactionContext) {
- transactionContext.deleteData(path);
+ transactionContext.writeData(path, data);
}
});
}
+ private void checkModificationState() {
+ Preconditions.checkState(type != TransactionType.READ_ONLY,
+ "Modification operation on read-only transaction is not allowed");
+ Preconditions.checkState(state == TransactionState.OPEN,
+ "Transaction is sealed - further modifications are not allowed");
+ }
+
private boolean seal(final TransactionState newState) {
if (state == TransactionState.OPEN) {
state = newState;
@@ -361,66 +198,16 @@ public class TransactionProxy extends AbstractDOMStoreTransaction> cohortFutures = new ArrayList<>(txFutureCallbackMap.size());
- for(TransactionFutureCallback txFutureCallback : txFutureCallbackMap.values()) {
-
- LOG.debug("Tx {} Readying transaction for shard {} chain {}", getIdentifier(),
- txFutureCallback.getShardName(), transactionChainId);
-
- final TransactionContext transactionContext = txFutureCallback.getTransactionContext();
- final Future future;
- if (transactionContext != null) {
- // avoid the creation of a promise and a TransactionOperation
- future = transactionContext.readyTransaction();
- } else {
- final Promise promise = akka.dispatch.Futures.promise();
- txFutureCallback.enqueueTransactionOperation(new TransactionOperation() {
- @Override
- public void invoke(TransactionContext transactionContext) {
- promise.completeWith(transactionContext.readyTransaction());
- }
- });
- future = promise.future();
- }
-
- cohortFutures.add(future);
- }
-
- return new ThreePhaseCommitCohortProxy(actorContext, cohortFutures,
- getIdentifier().toString());
- }
-
- @Override
- public void close() {
+ public final void close() {
if (!seal(TransactionState.CLOSED)) {
- if (state == TransactionState.CLOSED) {
- // Idempotent no-op as per AutoCloseable recommendation
- return;
- }
-
- throw new IllegalStateException(String.format("Transaction %s is ready, it cannot be closed",
- getIdentifier()));
+ Preconditions.checkState(state == TransactionState.CLOSED, "Transaction %s is ready, it cannot be closed",
+ getIdentifier());
+ // Idempotent no-op as per AutoCloseable recommendation
+ return;
}
- for (TransactionFutureCallback txFutureCallback : txFutureCallbackMap.values()) {
- txFutureCallback.enqueueTransactionOperation(new TransactionOperation() {
+ for (TransactionContextWrapper contextWrapper : txContextWrappers.values()) {
+ contextWrapper.maybeExecuteTransactionOperation(new TransactionOperation() {
@Override
public void invoke(TransactionContext transactionContext) {
transactionContext.closeTransaction();
@@ -428,308 +215,120 @@ public class TransactionProxy extends AbstractDOMStoreTransaction sendFindPrimaryShardAsync(String shardName) {
- return actorContext.findPrimaryShardAsync(shardName);
+ txContextWrappers.clear();
}
- private TransactionFutureCallback getOrCreateTxFutureCallback(YangInstanceIdentifier path) {
- String shardName = shardNameFromIdentifier(path);
- return getOrCreateTxFutureCallback(shardName);
- }
-
- private TransactionFutureCallback getOrCreateTxFutureCallback(String shardName) {
- TransactionFutureCallback txFutureCallback = txFutureCallbackMap.get(shardName);
- if(txFutureCallback == null) {
- Future findPrimaryFuture = sendFindPrimaryShardAsync(shardName);
-
- final TransactionFutureCallback newTxFutureCallback = new TransactionFutureCallback(shardName);
+ @Override
+ public final AbstractThreePhaseCommitCohort> ready() {
+ Preconditions.checkState(type != TransactionType.READ_ONLY, "Read-only transactions cannot be readied");
- txFutureCallback = newTxFutureCallback;
- txFutureCallbackMap.put(shardName, txFutureCallback);
+ final boolean success = seal(TransactionState.READY);
+ Preconditions.checkState(success, "Transaction %s is %s, it cannot be readied", getIdentifier(), state);
- findPrimaryFuture.onComplete(new OnComplete() {
- @Override
- public void onComplete(Throwable failure, ActorSelection primaryShard) {
- if(failure != null) {
- newTxFutureCallback.createTransactionContext(failure, null);
- } else {
- newTxFutureCallback.setPrimaryShard(primaryShard);
- }
- }
- }, actorContext.getClientDispatcher());
+ LOG.debug("Tx {} Readying {} components for commit", getIdentifier(), txContextWrappers.size());
+
+ final AbstractThreePhaseCommitCohort> ret;
+ switch (txContextWrappers.size()) {
+ case 0:
+ ret = NoOpDOMStoreThreePhaseCommitCohort.INSTANCE;
+ break;
+ case 1:
+ final Entry e = Iterables.getOnlyElement(txContextWrappers.entrySet());
+ ret = createSingleCommitCohort(e.getKey(), e.getValue());
+ break;
+ default:
+ ret = createMultiCommitCohort(txContextWrappers.entrySet());
}
- return txFutureCallback;
- }
-
- public String getTransactionChainId() {
- return transactionChainId;
- }
+ txContextFactory.onTransactionReady(getIdentifier(), ret.getCohortFutures());
- protected ActorContext getActorContext() {
- return actorContext;
+ final Throwable debugContext = getDebugContext();
+ return debugContext == null ? ret : new DebugThreePhaseCommitCohort(getIdentifier(), ret, debugContext);
}
- /**
- * Implements a Future OnComplete callback for a CreateTransaction message. This class handles
- * retries, up to a limit, if the shard doesn't have a leader yet. This is done by scheduling a
- * retry task after a short delay.
- *