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=d93bae22e08d9fddb3f1ac7d9c12aa4a278d0ff6;hb=233db109dea38ed45ca3c48eba04f302e38a9139;hp=6183c489c4cdbc56a1ba9ac0c3c3939963277edb;hpb=c5966fe28f0ccdcc56c5690f138831778f007ea4;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 6183c489c4..e7a00042e4 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,484 +5,404 @@
* 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.ActorPath;
-import akka.actor.ActorRef;
import akka.actor.ActorSelection;
-import akka.actor.Props;
-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.Iterables;
import com.google.common.util.concurrent.CheckedFuture;
import com.google.common.util.concurrent.Futures;
+import com.google.common.util.concurrent.ListenableFuture;
import com.google.common.util.concurrent.SettableFuture;
-
+import java.util.ArrayList;
+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.Semaphore;
+import java.util.concurrent.TimeUnit;
import org.opendaylight.controller.cluster.datastore.identifiers.TransactionIdentifier;
-import org.opendaylight.controller.cluster.datastore.messages.CloseTransaction;
-import org.opendaylight.controller.cluster.datastore.messages.CreateTransaction;
-import org.opendaylight.controller.cluster.datastore.messages.CreateTransactionReply;
-import org.opendaylight.controller.cluster.datastore.messages.DataExists;
-import org.opendaylight.controller.cluster.datastore.messages.DataExistsReply;
-import org.opendaylight.controller.cluster.datastore.messages.DeleteData;
-import org.opendaylight.controller.cluster.datastore.messages.MergeData;
-import org.opendaylight.controller.cluster.datastore.messages.ReadData;
-import org.opendaylight.controller.cluster.datastore.messages.ReadDataReply;
-import org.opendaylight.controller.cluster.datastore.messages.ReadyTransaction;
-import org.opendaylight.controller.cluster.datastore.messages.ReadyTransactionReply;
-import org.opendaylight.controller.cluster.datastore.messages.WriteData;
import org.opendaylight.controller.cluster.datastore.shardstrategy.ShardStrategyFactory;
import org.opendaylight.controller.cluster.datastore.utils.ActorContext;
+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.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
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 java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.concurrent.atomic.AtomicLong;
+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 implements DOMStoreReadWriteTransaction {
- public enum TransactionType {
- READ_ONLY,
- WRITE_ONLY,
- READ_WRITE
+public class TransactionProxy extends AbstractDOMStoreTransaction implements DOMStoreReadWriteTransaction {
+ private static enum TransactionState {
+ OPEN,
+ READY,
+ CLOSED,
}
-
- private static final AtomicLong counter = new AtomicLong();
-
- private static final Logger
- LOG = LoggerFactory.getLogger(TransactionProxy.class);
-
-
- private final TransactionType transactionType;
- private final ActorContext actorContext;
- private final Map remoteTransactionPaths = new HashMap<>();
- private final TransactionIdentifier identifier;
- private final SchemaContext schemaContext;
- private boolean inReadyState;
-
- public TransactionProxy(ActorContext actorContext, TransactionType transactionType,
- SchemaContext schemaContext) {
- this.actorContext = Preconditions.checkNotNull(actorContext, "actorContext should not be null");
- this.transactionType = Preconditions.checkNotNull(transactionType, "transactionType should not be null");
- this.schemaContext = Preconditions.checkNotNull(schemaContext, "schemaContext should not be null");
-
- String memberName = actorContext.getCurrentMemberName();
- if(memberName == null){
- memberName = "UNKNOWN-MEMBER";
- }
-
- this.identifier = TransactionIdentifier.builder().memberName(memberName).counter(
- counter.getAndIncrement()).build();
-
- LOG.debug("Created txn {} of type {}", identifier, transactionType);
-
+ private static final Logger LOG = LoggerFactory.getLogger(TransactionProxy.class);
+
+ private final Map txContextAdapters = new HashMap<>();
+ private final AbstractTransactionContextFactory> txContextFactory;
+ private final TransactionType type;
+ private TransactionState state = TransactionState.OPEN;
+ private volatile OperationCompleter operationCompleter;
+ private volatile Semaphore operationLimiter;
+
+ @VisibleForTesting
+ public TransactionProxy(final AbstractTransactionContextFactory> txContextFactory, final TransactionType type) {
+ super(txContextFactory.nextIdentifier(), txContextFactory.getActorContext().getDatastoreContext()
+ .isTransactionDebugContextEnabled());
+ this.txContextFactory = txContextFactory;
+ this.type = Preconditions.checkNotNull(type);
+
+ LOG.debug("New {} Tx - {}", type, getIdentifier());
}
@Override
- public CheckedFuture>, ReadFailedException> read(
- final YangInstanceIdentifier path) {
+ public CheckedFuture exists(final YangInstanceIdentifier path) {
+ Preconditions.checkState(type != TransactionType.WRITE_ONLY, "Reads from write-only transactions are not allowed");
- Preconditions.checkState(transactionType != TransactionType.WRITE_ONLY,
- "Read operation on write-only transaction is not allowed");
+ LOG.debug("Tx {} exists {}", getIdentifier(), path);
- LOG.debug("txn {} read {}", identifier, path);
+ throttleOperation();
- createTransactionIfMissing(actorContext, path);
+ final SettableFuture proxyFuture = SettableFuture.create();
+ TransactionContextWrapper contextAdapter = getContextAdapter(path);
+ contextAdapter.maybeExecuteTransactionOperation(new TransactionOperation() {
+ @Override
+ public void invoke(TransactionContext transactionContext) {
+ transactionContext.dataExists(path, proxyFuture);
+ }
+ });
- return transactionContext(path).readData(path);
+ return MappingCheckedFuture.create(proxyFuture, ReadFailedException.MAPPER);
}
@Override
- public CheckedFuture exists(YangInstanceIdentifier path) {
-
- Preconditions.checkState(transactionType != TransactionType.WRITE_ONLY,
- "Exists operation on write-only transaction is not allowed");
+ public CheckedFuture>, ReadFailedException> read(final YangInstanceIdentifier path) {
+ Preconditions.checkState(type != TransactionType.WRITE_ONLY, "Reads from write-only transactions are not allowed");
- LOG.debug("txn {} exists {}", identifier, path);
+ LOG.debug("Tx {} read {}", getIdentifier(), path);
- createTransactionIfMissing(actorContext, path);
+ if (YangInstanceIdentifier.EMPTY.equals(path)) {
+ return readAllData();
+ } else {
+ throttleOperation();
- return transactionContext(path).dataExists(path);
+ return singleShardRead(shardNameFromIdentifier(path), path);
+ }
}
- private void checkModificationState() {
- Preconditions.checkState(transactionType != TransactionType.READ_ONLY,
- "Modification operation on read-only transaction is not allowed");
- Preconditions.checkState(!inReadyState,
- "Transaction is sealed - further modifications are allowed");
+ private CheckedFuture>, ReadFailedException> singleShardRead(
+ final String shardName, final YangInstanceIdentifier path) {
+ final SettableFuture>> proxyFuture = SettableFuture.create();
+ TransactionContextWrapper contextAdapter = getContextAdapter(shardName);
+ contextAdapter.maybeExecuteTransactionOperation(new TransactionOperation() {
+ @Override
+ public void invoke(TransactionContext transactionContext) {
+ transactionContext.readData(path, proxyFuture);
+ }
+ });
+
+ return MappingCheckedFuture.create(proxyFuture, ReadFailedException.MAPPER);
}
- @Override
- public void write(YangInstanceIdentifier path, NormalizedNode, ?> data) {
+ private CheckedFuture>, ReadFailedException> readAllData() {
+ final Set allShardNames = txContextFactory.getActorContext().getConfiguration().getAllShardNames();
+ final Collection>, ReadFailedException>> futures = new ArrayList<>(allShardNames.size());
- checkModificationState();
+ for (String shardName : allShardNames) {
+ futures.add(singleShardRead(shardName, YangInstanceIdentifier.EMPTY));
+ }
- LOG.debug("txn {} write {}", identifier, path);
+ final ListenableFuture>>> listFuture = Futures.allAsList(futures);
+ final ListenableFuture>> aggregateFuture;
- createTransactionIfMissing(actorContext, path);
+ 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);
+ }
+ }
+ });
- transactionContext(path).writeData(path, data);
+ return MappingCheckedFuture.create(aggregateFuture, ReadFailedException.MAPPER);
}
@Override
- public void merge(YangInstanceIdentifier path, NormalizedNode, ?> data) {
-
+ public void delete(final YangInstanceIdentifier path) {
checkModificationState();
- LOG.debug("txn {} merge {}", identifier, path);
+ LOG.debug("Tx {} delete {}", getIdentifier(), path);
- createTransactionIfMissing(actorContext, path);
+ throttleOperation();
- transactionContext(path).mergeData(path, data);
+ TransactionContextWrapper contextAdapter = getContextAdapter(path);
+ contextAdapter.maybeExecuteTransactionOperation(new TransactionOperation() {
+ @Override
+ public void invoke(TransactionContext transactionContext) {
+ transactionContext.deleteData(path);
+ }
+ });
}
@Override
- public void delete(YangInstanceIdentifier path) {
-
+ public void merge(final YangInstanceIdentifier path, final NormalizedNode, ?> data) {
checkModificationState();
- LOG.debug("txn {} delete {}", identifier, path);
+ LOG.debug("Tx {} merge {}", getIdentifier(), path);
- createTransactionIfMissing(actorContext, path);
+ throttleOperation();
- transactionContext(path).deleteData(path);
+ TransactionContextWrapper contextAdapter = getContextAdapter(path);
+ contextAdapter.maybeExecuteTransactionOperation(new TransactionOperation() {
+ @Override
+ public void invoke(TransactionContext transactionContext) {
+ transactionContext.mergeData(path, data);
+ }
+ });
}
@Override
- public DOMStoreThreePhaseCommitCohort ready() {
-
+ public void write(final YangInstanceIdentifier path, final NormalizedNode, ?> data) {
checkModificationState();
- inReadyState = true;
-
- List cohortPaths = new ArrayList<>();
+ LOG.debug("Tx {} write {}", getIdentifier(), path);
- LOG.debug("txn {} Trying to get {} transactions ready for commit", identifier,
- remoteTransactionPaths.size());
+ throttleOperation();
- for(TransactionContext transactionContext : remoteTransactionPaths.values()) {
-
- LOG.debug("txn {} Readying transaction for shard {}", identifier,
- transactionContext.getShardName());
-
- Object result = transactionContext.readyTransaction();
-
- if(result.getClass().equals(ReadyTransactionReply.SERIALIZABLE_CLASS)){
- ReadyTransactionReply reply = ReadyTransactionReply.fromSerializable(
- actorContext.getActorSystem(),result);
- String resolvedCohortPath = transactionContext.getResolvedCohortPath(
- reply.getCohortPath().toString());
- cohortPaths.add(actorContext.actorFor(resolvedCohortPath));
- } else {
- LOG.error("Was expecting {} but got {}", ReadyTransactionReply.SERIALIZABLE_CLASS,
- result.getClass());
+ TransactionContextWrapper contextAdapter = getContextAdapter(path);
+ contextAdapter.maybeExecuteTransactionOperation(new TransactionOperation() {
+ @Override
+ public void invoke(TransactionContext transactionContext) {
+ transactionContext.writeData(path, data);
}
- }
-
- return new ThreePhaseCommitCohortProxy(actorContext, cohortPaths, identifier.toString());
+ });
}
- @Override
- public Object getIdentifier() {
- return this.identifier;
+ 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");
}
- @Override
- public void close() {
- for(TransactionContext transactionContext : remoteTransactionPaths.values()) {
- transactionContext.closeTransaction();
+ private boolean seal(final TransactionState newState) {
+ if (state == TransactionState.OPEN) {
+ state = newState;
+ return true;
+ } else {
+ return false;
}
}
- private TransactionContext transactionContext(YangInstanceIdentifier path){
- String shardName = shardNameFromIdentifier(path);
- return remoteTransactionPaths.get(shardName);
- }
-
- private String shardNameFromIdentifier(YangInstanceIdentifier path){
- return ShardStrategyFactory.getStrategy(path).findShard(path);
- }
-
- private void createTransactionIfMissing(ActorContext actorContext, YangInstanceIdentifier path) {
- String shardName = ShardStrategyFactory.getStrategy(path).findShard(path);
-
- TransactionContext transactionContext =
- remoteTransactionPaths.get(shardName);
-
- if(transactionContext != null){
- // A transaction already exists with that shard
+ @Override
+ public final void close() {
+ if (!seal(TransactionState.CLOSED)) {
+ Preconditions.checkState(state == TransactionState.CLOSED, "Transaction %s is ready, it cannot be closed",
+ getIdentifier());
+ // Idempotent no-op as per AutoCloseable recommendation
return;
}
- try {
- Object response = actorContext.executeShardOperation(shardName,
- new CreateTransaction(identifier.toString(),this.transactionType.ordinal() ).toSerializable(),
- ActorContext.ASK_DURATION);
- if (response.getClass().equals(CreateTransactionReply.SERIALIZABLE_CLASS)) {
- CreateTransactionReply reply =
- CreateTransactionReply.fromSerializable(response);
-
- String transactionPath = reply.getTransactionPath();
-
- LOG.debug("txn {} Received transaction path = {}", identifier, transactionPath);
-
- ActorSelection transactionActor =
- actorContext.actorSelection(transactionPath);
- transactionContext =
- new TransactionContextImpl(shardName, transactionPath,
- transactionActor);
-
- remoteTransactionPaths.put(shardName, transactionContext);
- } else {
- LOG.error("Was expecting {} but got {}", CreateTransactionReply.SERIALIZABLE_CLASS,
- response.getClass());
- }
- } catch(Exception e){
- LOG.error("txn {} Creating NoOpTransaction because of : {}", identifier, e.getMessage());
- remoteTransactionPaths.put(shardName, new NoOpTransactionContext(shardName, e));
+ for (TransactionContextWrapper contextAdapter : txContextAdapters.values()) {
+ contextAdapter.maybeExecuteTransactionOperation(new TransactionOperation() {
+ @Override
+ public void invoke(TransactionContext transactionContext) {
+ transactionContext.closeTransaction();
+ }
+ });
}
- }
-
- private interface TransactionContext {
- String getShardName();
-
- String getResolvedCohortPath(String cohortPath);
-
- public void closeTransaction();
-
- public Object readyTransaction();
- void deleteData(YangInstanceIdentifier path);
- void mergeData(YangInstanceIdentifier path, NormalizedNode, ?> data);
-
- CheckedFuture>, ReadFailedException> readData(
- final YangInstanceIdentifier path);
-
- void writeData(YangInstanceIdentifier path, NormalizedNode, ?> data);
-
- CheckedFuture dataExists(YangInstanceIdentifier path);
+ txContextAdapters.clear();
}
-
- private class TransactionContextImpl implements TransactionContext {
- private final String shardName;
- private final String actorPath;
- private final ActorSelection actor;
-
-
- private TransactionContextImpl(String shardName, String actorPath,
- ActorSelection actor) {
- this.shardName = shardName;
- this.actorPath = actorPath;
- this.actor = actor;
- }
-
- @Override
- public String getShardName() {
- return shardName;
- }
-
- private ActorSelection getActor() {
- return actor;
- }
-
- @Override
- public String getResolvedCohortPath(String cohortPath) {
- return actorContext.resolvePath(actorPath, cohortPath);
- }
-
- @Override
- public void closeTransaction() {
- actorContext.sendRemoteOperationAsync(getActor(), new CloseTransaction().toSerializable());
+ @Override
+ public final AbstractThreePhaseCommitCohort> ready() {
+ Preconditions.checkState(type != TransactionType.READ_ONLY, "Read-only transactions cannot be readied");
+
+ final boolean success = seal(TransactionState.READY);
+ Preconditions.checkState(success, "Transaction %s is %s, it cannot be readied", getIdentifier(), state);
+
+ LOG.debug("Tx {} Readying {} components for commit", getIdentifier(), txContextAdapters.size());
+
+ final AbstractThreePhaseCommitCohort> ret;
+ switch (txContextAdapters.size()) {
+ case 0:
+ ret = NoOpDOMStoreThreePhaseCommitCohort.INSTANCE;
+ break;
+ case 1:
+ final Entry e = Iterables.getOnlyElement(txContextAdapters.entrySet());
+ ret = createSingleCommitCohort(e.getKey(), e.getValue());
+ break;
+ default:
+ ret = createMultiCommitCohort(txContextAdapters.entrySet());
}
- @Override
- public Object readyTransaction() {
- return actorContext.executeRemoteOperation(getActor(),
- new ReadyTransaction().toSerializable(), ActorContext.ASK_DURATION);
- }
+ txContextFactory.onTransactionReady(getIdentifier(), ret.getCohortFutures());
- @Override
- public void deleteData(YangInstanceIdentifier path) {
- actorContext.sendRemoteOperationAsync(getActor(), new DeleteData(path).toSerializable() );
- }
+ final Throwable debugContext = getDebugContext();
+ return debugContext == null ? ret : new DebugThreePhaseCommitCohort(getIdentifier(), ret, debugContext);
+ }
- @Override
- public void mergeData(YangInstanceIdentifier path, NormalizedNode, ?> data) {
- actorContext.sendRemoteOperationAsync(getActor(),
- new MergeData(path, data, schemaContext).toSerializable());
- }
+ private AbstractThreePhaseCommitCohort> createSingleCommitCohort(final String shardName,
+ final TransactionContextWrapper contextAdapter) {
+ throttleOperation();
- @Override
- public CheckedFuture>, ReadFailedException> readData(
- final YangInstanceIdentifier path) {
+ LOG.debug("Tx {} Readying transaction for shard {}", getIdentifier(), shardName);
- final SettableFuture>> returnFuture = SettableFuture.create();
+ final OperationCallback.Reference operationCallbackRef =
+ new OperationCallback.Reference(OperationCallback.NO_OP_CALLBACK);
- OnComplete