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=e37519d8465105f890824e1a7da2576129a750ce;hb=72d71d1cded60bcac65296211272754006b3f89a;hp=e397ab501c064adf98c5ee6c2f6708f05eb6f2fe;hpb=dea515c8870769408b9bea29f555d6b71ff43211;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 e397ab501c..e37519d846 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,346 +5,172 @@
* 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 static com.google.common.base.Preconditions.checkState;
+import static java.util.Objects.requireNonNull;
+
import akka.actor.ActorSelection;
-import akka.dispatch.Mapper;
-import akka.dispatch.OnComplete;
import com.google.common.annotations.VisibleForTesting;
-import com.google.common.base.Optional;
-import com.google.common.base.Preconditions;
-import com.google.common.collect.Lists;
-import com.google.common.util.concurrent.CheckedFuture;
+import com.google.common.collect.Iterables;
+import com.google.common.util.concurrent.FluentFuture;
import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.ListenableFuture;
+import com.google.common.util.concurrent.MoreExecutors;
import com.google.common.util.concurrent.SettableFuture;
import java.util.ArrayList;
-import java.util.HashMap;
+import java.util.Collection;
import java.util.List;
import java.util.Map;
+import java.util.Map.Entry;
+import java.util.Optional;
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 org.opendaylight.controller.cluster.datastore.compat.PreLithiumTransactionContextImpl;
-import org.opendaylight.controller.cluster.datastore.identifiers.TransactionIdentifier;
-import org.opendaylight.controller.cluster.datastore.messages.PrimaryShardInfo;
-import org.opendaylight.controller.cluster.datastore.shardstrategy.ShardStrategyFactory;
-import org.opendaylight.controller.cluster.datastore.utils.ActorContext;
+import java.util.SortedSet;
+import java.util.TreeMap;
+import java.util.TreeSet;
+import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
+import org.opendaylight.controller.cluster.datastore.messages.AbstractRead;
+import org.opendaylight.controller.cluster.datastore.messages.DataExists;
+import org.opendaylight.controller.cluster.datastore.messages.ReadData;
+import org.opendaylight.controller.cluster.datastore.modification.AbstractModification;
+import org.opendaylight.controller.cluster.datastore.modification.DeleteModification;
+import org.opendaylight.controller.cluster.datastore.modification.MergeModification;
+import org.opendaylight.controller.cluster.datastore.modification.WriteModification;
+import org.opendaylight.controller.cluster.datastore.utils.ActorUtils;
import org.opendaylight.controller.cluster.datastore.utils.NormalizedNodeAggregator;
-import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
-import org.opendaylight.controller.sal.core.spi.data.AbstractDOMStoreTransaction;
-import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadWriteTransaction;
-import org.opendaylight.yangtools.util.concurrent.MappingCheckedFuture;
+import org.opendaylight.mdsal.dom.spi.store.AbstractDOMStoreTransaction;
+import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadWriteTransaction;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
-import org.opendaylight.yangtools.yang.model.api.SchemaContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import scala.concurrent.Future;
import scala.concurrent.Promise;
/**
- * 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 {
+public class TransactionProxy extends AbstractDOMStoreTransaction
+ implements DOMStoreReadWriteTransaction {
+ private 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);
- /**
- * 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 TreeMap<>();
+ 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, "");
- }
-
- 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);
- }
-
- private static TransactionIdentifier createIdentifier(ActorContext actorContext) {
- String memberName = actorContext.getCurrentMemberName();
- if (memberName == null) {
- memberName = "UNKNOWN-MEMBER";
- }
-
- return new TransactionIdentifier(memberName, counter.getAndIncrement());
- }
-
@VisibleForTesting
- boolean hasTransactionContext() {
- for(TransactionFutureCallback txFutureCallback : txFutureCallbackMap.values()) {
- TransactionContext transactionContext = txFutureCallback.getTransactionContext();
- if(transactionContext != null) {
- return true;
- }
- }
+ public TransactionProxy(final AbstractTransactionContextFactory> txContextFactory, final TransactionType type) {
+ super(txContextFactory.nextIdentifier(), txContextFactory.getActorUtils().getDatastoreContext()
+ .isTransactionDebugContextEnabled());
+ this.txContextFactory = txContextFactory;
+ this.type = requireNonNull(type);
- return false;
- }
-
- private static boolean isRootPath(YangInstanceIdentifier path) {
- return !path.getPathArguments().iterator().hasNext();
+ LOG.debug("New {} Tx - {}", type, getIdentifier());
}
@Override
- public CheckedFuture>, ReadFailedException> read(final YangInstanceIdentifier path) {
-
- Preconditions.checkState(transactionType != TransactionType.WRITE_ONLY,
- "Read operation on write-only transaction is not allowed");
-
- LOG.debug("Tx {} read {}", getIdentifier(), path);
-
- final SettableFuture>> proxyFuture = SettableFuture.create();
-
- if(isRootPath(path)){
- readAllData(path, proxyFuture);
- } else {
- throttleOperation();
-
- TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path);
- txFutureCallback.enqueueTransactionOperation(new TransactionOperation() {
- @Override
- public void invoke(TransactionContext transactionContext) {
- transactionContext.readData(path, proxyFuture);
- }
- });
-
- }
-
- return MappingCheckedFuture.create(proxyFuture, ReadFailedException.MAPPER);
+ public FluentFuture exists(final YangInstanceIdentifier path) {
+ return executeRead(shardNameFromIdentifier(path), new DataExists(path, DataStoreVersions.CURRENT_VERSION));
}
- 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);
- }
+ private FluentFuture executeRead(final String shardName, final AbstractRead readCmd) {
+ checkState(type != TransactionType.WRITE_ONLY, "Reads from write-only transactions are not allowed");
- final ListenableFuture>>> future = Futures.allAsList(futures);
+ LOG.trace("Tx {} {} {}", getIdentifier(), readCmd.getClass().getSimpleName(), readCmd.getPath());
- future.addListener(new Runnable() {
+ final SettableFuture proxyFuture = SettableFuture.create();
+ TransactionContextWrapper contextWrapper = getContextWrapper(shardName);
+ contextWrapper.maybeExecuteTransactionOperation(new TransactionOperation() {
@Override
- public void run() {
- try {
- proxyFuture.set(NormalizedNodeAggregator.aggregate(YangInstanceIdentifier.builder().build(),
- future.get(), actorContext.getSchemaContext()));
- } catch (DataValidationFailedException | 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() {
- @Override
- public void invoke(TransactionContext transactionContext) {
- transactionContext.dataExists(path, proxyFuture);
+ public void invoke(final TransactionContext transactionContext, final Boolean havePermit) {
+ transactionContext.executeRead(readCmd, proxyFuture, havePermit);
}
});
- return MappingCheckedFuture.create(proxyFuture, ReadFailedException.MAPPER);
+ return FluentFuture.from(proxyFuture);
}
- 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");
+ @Override
+ public FluentFuture>> read(final YangInstanceIdentifier path) {
+ checkState(type != TransactionType.WRITE_ONLY, "Reads from write-only transactions are not allowed");
+ requireNonNull(path, "path should not be null");
+
+ LOG.trace("Tx {} read {}", getIdentifier(), path);
+ return path.isEmpty() ? readAllData() : singleShardRead(shardNameFromIdentifier(path), path);
}
- private void throttleOperation() {
- throttleOperation(1);
+ private FluentFuture>> singleShardRead(
+ final String shardName, final YangInstanceIdentifier path) {
+ return executeRead(shardName, new ReadData(path, DataStoreVersions.CURRENT_VERSION));
}
- 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 FluentFuture>> readAllData() {
+ final Set allShardNames = txContextFactory.getActorUtils().getConfiguration().getAllShardNames();
+ final Collection>>> 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, input -> {
+ try {
+ return NormalizedNodeAggregator.aggregate(YangInstanceIdentifier.EMPTY, input,
+ txContextFactory.getActorUtils().getSchemaContext(),
+ txContextFactory.getActorUtils().getDatastoreContext().getLogicalStoreType());
+ } catch (DataValidationFailedException e) {
+ throw new IllegalArgumentException("Failed to aggregate", e);
}
- }
- }
+ }, MoreExecutors.directExecutor());
- final void ensureInitializied() {
- Preconditions.checkState(initialized, "Transaction %s was not propertly initialized.", getIdentifier());
+ return FluentFuture.from(aggregateFuture);
}
@Override
- public void write(final YangInstanceIdentifier path, final NormalizedNode, ?> data) {
-
- checkModificationState();
-
- LOG.debug("Tx {} write {}", getIdentifier(), path);
-
- throttleOperation();
-
- TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path);
- txFutureCallback.enqueueTransactionOperation(new TransactionOperation() {
- @Override
- public void invoke(TransactionContext transactionContext) {
- transactionContext.writeData(path, data);
- }
- });
+ public void delete(final YangInstanceIdentifier path) {
+ executeModification(new DeleteModification(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() {
- @Override
- public void invoke(TransactionContext transactionContext) {
- transactionContext.mergeData(path, data);
- }
- });
+ executeModification(new MergeModification(path, data));
}
@Override
- public void delete(final YangInstanceIdentifier path) {
+ public void write(final YangInstanceIdentifier path, final NormalizedNode, ?> data) {
+ executeModification(new WriteModification(path, data));
+ }
+ private void executeModification(final AbstractModification modification) {
checkModificationState();
- LOG.debug("Tx {} delete {}", getIdentifier(), path);
-
- throttleOperation();
+ LOG.trace("Tx {} executeModification {} {}", getIdentifier(), modification.getClass().getSimpleName(),
+ modification.getPath());
- TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path);
- txFutureCallback.enqueueTransactionOperation(new TransactionOperation() {
+ TransactionContextWrapper contextWrapper = getContextWrapper(modification.getPath());
+ contextWrapper.maybeExecuteTransactionOperation(new TransactionOperation() {
@Override
- public void invoke(TransactionContext transactionContext) {
- transactionContext.deleteData(path);
+ protected void invoke(final TransactionContext transactionContext, final Boolean havePermit) {
+ transactionContext.executeModification(modification, havePermit);
}
});
}
+ private void checkModificationState() {
+ checkState(type != TransactionType.READ_ONLY, "Modification operation on read-only transaction is not allowed");
+ checkState(state == TransactionState.OPEN, "Transaction is sealed - further modifications are not allowed");
+ }
+
private boolean seal(final TransactionState newState) {
if (state == TransactionState.OPEN) {
state = newState;
@@ -355,214 +181,142 @@ public class TransactionProxy extends AbstractDOMStoreTransaction ready() {
- Preconditions.checkState(transactionType != TransactionType.READ_ONLY,
- "Read-only transactions cannot be readied");
+ public final void close() {
+ if (!seal(TransactionState.CLOSED)) {
+ checkState(state == TransactionState.CLOSED, "Transaction %s is ready, it cannot be closed",
+ getIdentifier());
+ // Idempotent no-op as per AutoCloseable recommendation
+ return;
+ }
- final boolean success = seal(TransactionState.READY);
- Preconditions.checkState(success, "Transaction %s is %s, it cannot be readied", getIdentifier(), state);
+ for (TransactionContextWrapper contextWrapper : txContextWrappers.values()) {
+ contextWrapper.maybeExecuteTransactionOperation(new TransactionOperation() {
+ @Override
+ public void invoke(final TransactionContext transactionContext, final Boolean havePermit) {
+ transactionContext.closeTransaction();
+ }
+ });
+ }
- LOG.debug("Tx {} Readying {} transactions for commit", getIdentifier(),
- txFutureCallbackMap.size());
- if (txFutureCallbackMap.isEmpty()) {
- TransactionRateLimitingCallback.adjustRateLimitForUnusedTransaction(actorContext);
- return NoOpDOMStoreThreePhaseCommitCohort.INSTANCE;
+ txContextWrappers.clear();
+ }
+
+ @Override
+ public final AbstractThreePhaseCommitCohort> ready() {
+ checkState(type != TransactionType.READ_ONLY, "Read-only transactions cannot be readied");
+
+ final boolean success = seal(TransactionState.READY);
+ checkState(success, "Transaction %s is %s, it cannot be readied", getIdentifier(), state);
+
+ 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();
}
- throttleOperation(txFutureCallbackMap.size());
+ txContextFactory.onTransactionReady(getIdentifier(), ret.getCohortFutures());
- final boolean isSingleShard = txFutureCallbackMap.size() == 1;
- return isSingleShard ? createSingleCommitCohort() : createMultiCommitCohort();
+ final Throwable debugContext = getDebugContext();
+ return debugContext == null ? ret : new DebugThreePhaseCommitCohort(getIdentifier(), ret, debugContext);
}
@SuppressWarnings({ "rawtypes", "unchecked" })
- private AbstractThreePhaseCommitCohort