X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-distributed-datastore%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fdatastore%2FTransactionProxy.java;h=d79cd6f69f4b0e3e4f1171a332b45c36adbbd515;hp=9f48ef96cf517e265970b744b87af014dc51cbca;hb=166c432bc0611288abf2e13ef8f184cfbb2c101a;hpb=52618cba48189dc021cb9d440645a34c772ee007 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 9f48ef96cf..d79cd6f69f 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 @@ -21,6 +21,8 @@ import com.google.common.util.concurrent.CheckedFuture; import com.google.common.util.concurrent.FutureCallback; import com.google.common.util.concurrent.Futures; 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; @@ -35,17 +37,6 @@ import org.opendaylight.controller.cluster.datastore.identifiers.TransactionIden 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.SerializableMessage; -import org.opendaylight.controller.cluster.datastore.messages.VersionedSerializableMessage; -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.md.sal.common.api.data.ReadFailedException; @@ -576,15 +567,19 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { * Adds a TransactionOperation to be executed after the CreateTransaction completes. */ void addTxOperationOnComplete(TransactionOperation operation) { + boolean invokeOperation = true; synchronized(txOperationsOnComplete) { if(transactionContext == null) { LOG.debug("Tx {} Adding operation on complete {}", identifier); + invokeOperation = false; txOperationsOnComplete.add(operation); - } else { - operation.invoke(transactionContext); } } + + if(invokeOperation) { + operation.invoke(transactionContext); + } } @@ -689,43 +684,63 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { } } - // Create the TransactionContext from the response or failure and execute delayed - // TransactionOperations. This entire section is done atomically (ie synchronized) with - // respect to #addTxOperationOnComplete to handle timing issues and ensure no - // TransactionOperation is missed and that they are processed in the order they occurred. - synchronized(txOperationsOnComplete) { - // Store the new TransactionContext locally until we've completed invoking the - // TransactionOperations. This avoids thread timing issues which could cause - // out-of-order TransactionOperations. Eg, on a modification operation, if the - // TransactionContext is non-null, then we directly call the TransactionContext. - // However, at the same time, the code may be executing the cached - // TransactionOperations. So to avoid thus timing, we don't publish the - // TransactionContext until after we've executed all cached TransactionOperations. - TransactionContext localTransactionContext; - if(failure != null) { - LOG.debug("Tx {} Creating NoOpTransaction because of error: {}", identifier, - failure.getMessage()); - - localTransactionContext = new NoOpTransactionContext(failure, identifier, operationLimiter); - } else if (response.getClass().equals(CreateTransactionReply.SERIALIZABLE_CLASS)) { - localTransactionContext = createValidTransactionContext( - CreateTransactionReply.fromSerializable(response)); - } else { - IllegalArgumentException exception = new IllegalArgumentException(String.format( + // Create the TransactionContext from the response or failure. Store the new + // TransactionContext locally until we've completed invoking the + // TransactionOperations. This avoids thread timing issues which could cause + // out-of-order TransactionOperations. Eg, on a modification operation, if the + // TransactionContext is non-null, then we directly call the TransactionContext. + // However, at the same time, the code may be executing the cached + // TransactionOperations. So to avoid thus timing, we don't publish the + // TransactionContext until after we've executed all cached TransactionOperations. + TransactionContext localTransactionContext; + if(failure != null) { + LOG.debug("Tx {} Creating NoOpTransaction because of error: {}", identifier, + failure.getMessage()); + + localTransactionContext = new NoOpTransactionContext(failure, identifier, operationLimiter); + } else if (response.getClass().equals(CreateTransactionReply.SERIALIZABLE_CLASS)) { + localTransactionContext = createValidTransactionContext( + CreateTransactionReply.fromSerializable(response)); + } else { + IllegalArgumentException exception = new IllegalArgumentException(String.format( "Invalid reply type %s for CreateTransaction", response.getClass())); - localTransactionContext = new NoOpTransactionContext(exception, identifier, operationLimiter); + localTransactionContext = new NoOpTransactionContext(exception, identifier, operationLimiter); + } + + executeTxOperatonsOnComplete(localTransactionContext); + } + + private void executeTxOperatonsOnComplete(TransactionContext localTransactionContext) { + while(true) { + // Access to txOperationsOnComplete and transactionContext must be protected and atomic + // (ie synchronized) with respect to #addTxOperationOnComplete to handle timing + // issues and ensure no TransactionOperation is missed and that they are processed + // in the order they occurred. + + // We'll make a local copy of the txOperationsOnComplete list to handle re-entrancy + // in case a TransactionOperation results in another transaction operation being + // queued (eg a put operation from a client read Future callback that is notified + // synchronously). + Collection operationsBatch = null; + synchronized(txOperationsOnComplete) { + if(txOperationsOnComplete.isEmpty()) { + // We're done invoking the TransactionOperations so we can now publish the + // TransactionContext. + transactionContext = localTransactionContext; + break; + } + + operationsBatch = new ArrayList<>(txOperationsOnComplete); + txOperationsOnComplete.clear(); } - for(TransactionOperation oper: txOperationsOnComplete) { + // Invoke TransactionOperations outside the sync block to avoid unnecessary blocking. + // A slight down-side is that we need to re-acquire the lock below but this should + // be negligible. + for(TransactionOperation oper: operationsBatch) { oper.invoke(localTransactionContext); } - - txOperationsOnComplete.clear(); - - // We're done invoking the TransactionOperations so we can now publish the - // TransactionContext. - transactionContext = localTransactionContext; } } @@ -754,420 +769,4 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { actorContext, schemaContext, isTxActorLocal, reply.getVersion(), operationCompleter); } } - - private interface TransactionContext { - void closeTransaction(); - - Future readyTransaction(); - - void writeData(YangInstanceIdentifier path, NormalizedNode data); - - void deleteData(YangInstanceIdentifier path); - - void mergeData(YangInstanceIdentifier path, NormalizedNode data); - - CheckedFuture>, ReadFailedException> readData( - final YangInstanceIdentifier path); - - CheckedFuture dataExists(YangInstanceIdentifier path); - - List> getRecordedOperationFutures(); - } - - private static abstract class AbstractTransactionContext implements TransactionContext { - - protected final TransactionIdentifier identifier; - protected final List> recordedOperationFutures = Lists.newArrayList(); - - AbstractTransactionContext(TransactionIdentifier identifier) { - this.identifier = identifier; - } - - @Override - public List> getRecordedOperationFutures() { - return recordedOperationFutures; - } - } - - private static class TransactionContextImpl extends AbstractTransactionContext { - private final Logger LOG = LoggerFactory.getLogger(TransactionContextImpl.class); - - private final ActorContext actorContext; - private final String transactionPath; - private final ActorSelection actor; - private final boolean isTxActorLocal; - private final short remoteTransactionVersion; - private final OperationCompleter operationCompleter; - - - private TransactionContextImpl(String transactionPath, ActorSelection actor, TransactionIdentifier identifier, - ActorContext actorContext, SchemaContext schemaContext, - boolean isTxActorLocal, short remoteTransactionVersion, OperationCompleter operationCompleter) { - super(identifier); - this.transactionPath = transactionPath; - this.actor = actor; - this.actorContext = actorContext; - this.isTxActorLocal = isTxActorLocal; - this.remoteTransactionVersion = remoteTransactionVersion; - this.operationCompleter = operationCompleter; - } - - private Future completeOperation(Future operationFuture){ - operationFuture.onComplete(this.operationCompleter, actorContext.getActorSystem().dispatcher()); - return operationFuture; - } - - - private ActorSelection getActor() { - return actor; - } - - private Future executeOperationAsync(SerializableMessage msg) { - return completeOperation(actorContext.executeOperationAsync(getActor(), isTxActorLocal ? msg : msg.toSerializable())); - } - - private Future executeOperationAsync(VersionedSerializableMessage msg) { - return completeOperation(actorContext.executeOperationAsync(getActor(), isTxActorLocal ? msg : - msg.toSerializable(remoteTransactionVersion))); - } - - @Override - public void closeTransaction() { - LOG.debug("Tx {} closeTransaction called", identifier); - - actorContext.sendOperationAsync(getActor(), CloseTransaction.INSTANCE.toSerializable()); - } - - @Override - public Future readyTransaction() { - LOG.debug("Tx {} readyTransaction called with {} previous recorded operations pending", - identifier, recordedOperationFutures.size()); - - // Send the ReadyTransaction message to the Tx actor. - - final Future replyFuture = executeOperationAsync(ReadyTransaction.INSTANCE); - - // Combine all the previously recorded put/merge/delete operation reply Futures and the - // ReadyTransactionReply Future into one Future. If any one fails then the combined - // Future will fail. We need all prior operations and the ready operation to succeed - // in order to attempt commit. - - List> futureList = - Lists.newArrayListWithCapacity(recordedOperationFutures.size() + 1); - futureList.addAll(recordedOperationFutures); - futureList.add(replyFuture); - - Future> combinedFutures = akka.dispatch.Futures.sequence(futureList, - actorContext.getActorSystem().dispatcher()); - - // Transform the combined Future into a Future that returns the cohort actor path from - // the ReadyTransactionReply. That's the end result of the ready operation. - - return combinedFutures.transform(new Mapper, ActorSelection>() { - @Override - public ActorSelection checkedApply(Iterable notUsed) { - LOG.debug("Tx {} readyTransaction: pending recorded operations succeeded", - identifier); - - // At this point all the Futures succeeded and we need to extract the cohort - // actor path from the ReadyTransactionReply. For the recorded operations, they - // don't return any data so we're only interested that they completed - // successfully. We could be paranoid and verify the correct reply types but - // that really should never happen so it's not worth the overhead of - // de-serializing each reply. - - // Note the Future get call here won't block as it's complete. - Object serializedReadyReply = replyFuture.value().get().get(); - if (serializedReadyReply instanceof ReadyTransactionReply) { - return actorContext.actorSelection(((ReadyTransactionReply)serializedReadyReply).getCohortPath()); - - } else if(serializedReadyReply.getClass().equals(ReadyTransactionReply.SERIALIZABLE_CLASS)) { - ReadyTransactionReply reply = ReadyTransactionReply.fromSerializable(serializedReadyReply); - String cohortPath = reply.getCohortPath(); - - // In Helium we used to return the local path of the actor which represented - // a remote ThreePhaseCommitCohort. The local path would then be converted to - // a remote path using this resolvePath method. To maintain compatibility with - // a Helium node we need to continue to do this conversion. - // At some point in the future when upgrades from Helium are not supported - // we could remove this code to resolvePath and just use the cohortPath as the - // resolved cohortPath - if(TransactionContextImpl.this.remoteTransactionVersion < - DataStoreVersions.HELIUM_1_VERSION) { - cohortPath = actorContext.resolvePath(transactionPath, cohortPath); - } - - return actorContext.actorSelection(cohortPath); - - } else { - // Throwing an exception here will fail the Future. - throw new IllegalArgumentException(String.format("Invalid reply type {}", - serializedReadyReply.getClass())); - } - } - }, SAME_FAILURE_TRANSFORMER, actorContext.getActorSystem().dispatcher()); - } - - @Override - public void deleteData(YangInstanceIdentifier path) { - LOG.debug("Tx {} deleteData called path = {}", identifier, path); - - recordedOperationFutures.add(executeOperationAsync(new DeleteData(path))); - } - - @Override - public void mergeData(YangInstanceIdentifier path, NormalizedNode data) { - LOG.debug("Tx {} mergeData called path = {}", identifier, path); - - recordedOperationFutures.add(executeOperationAsync(new MergeData(path, data))); - } - - @Override - public void writeData(YangInstanceIdentifier path, NormalizedNode data) { - LOG.debug("Tx {} writeData called path = {}", identifier, path); - - recordedOperationFutures.add(executeOperationAsync(new WriteData(path, data))); - } - - @Override - public CheckedFuture>, ReadFailedException> readData( - final YangInstanceIdentifier path) { - - LOG.debug("Tx {} readData called path = {}", identifier, path); - - final SettableFuture>> returnFuture = SettableFuture.create(); - - // If there were any previous recorded put/merge/delete operation reply Futures then we - // must wait for them to successfully complete. This is necessary to honor the read - // uncommitted semantics of the public API contract. If any one fails then fail the read. - - if(recordedOperationFutures.isEmpty()) { - finishReadData(path, returnFuture); - } else { - LOG.debug("Tx {} readData: verifying {} previous recorded operations", - identifier, recordedOperationFutures.size()); - - // Note: we make a copy of recordedOperationFutures to be on the safe side in case - // Futures#sequence accesses the passed List on a different thread, as - // recordedOperationFutures is not synchronized. - - Future> combinedFutures = akka.dispatch.Futures.sequence( - Lists.newArrayList(recordedOperationFutures), - actorContext.getActorSystem().dispatcher()); - - OnComplete> onComplete = new OnComplete>() { - @Override - public void onComplete(Throwable failure, Iterable notUsed) - throws Throwable { - if(failure != null) { - LOG.debug("Tx {} readData: a recorded operation failed: {}", - identifier, failure); - returnFuture.setException(new ReadFailedException( - "The read could not be performed because a previous put, merge," - + "or delete operation failed", failure)); - } else { - finishReadData(path, returnFuture); - } - } - }; - - combinedFutures.onComplete(onComplete, actorContext.getActorSystem().dispatcher()); - } - - return MappingCheckedFuture.create(returnFuture, ReadFailedException.MAPPER); - } - - private void finishReadData(final YangInstanceIdentifier path, - final SettableFuture>> returnFuture) { - - LOG.debug("Tx {} finishReadData called path = {}", identifier, path); - - OnComplete onComplete = new OnComplete() { - @Override - public void onComplete(Throwable failure, Object readResponse) throws Throwable { - if(failure != null) { - LOG.debug("Tx {} read operation failed: {}", identifier, failure); - returnFuture.setException(new ReadFailedException( - "Error reading data for path " + path, failure)); - - } else { - LOG.debug("Tx {} read operation succeeded", identifier, failure); - - if (readResponse instanceof ReadDataReply) { - ReadDataReply reply = (ReadDataReply) readResponse; - returnFuture.set(Optional.>fromNullable(reply.getNormalizedNode())); - - } else if (ReadDataReply.isSerializedType(readResponse)) { - ReadDataReply reply = ReadDataReply.fromSerializable(readResponse); - returnFuture.set(Optional.>fromNullable(reply.getNormalizedNode())); - - } else { - returnFuture.setException(new ReadFailedException( - "Invalid response reading data for path " + path)); - } - } - } - }; - - Future readFuture = executeOperationAsync(new ReadData(path)); - - readFuture.onComplete(onComplete, actorContext.getActorSystem().dispatcher()); - } - - @Override - public CheckedFuture dataExists( - final YangInstanceIdentifier path) { - - LOG.debug("Tx {} dataExists called path = {}", identifier, path); - - final SettableFuture returnFuture = SettableFuture.create(); - - // If there were any previous recorded put/merge/delete operation reply Futures then we - // must wait for them to successfully complete. This is necessary to honor the read - // uncommitted semantics of the public API contract. If any one fails then fail this - // request. - - if(recordedOperationFutures.isEmpty()) { - finishDataExists(path, returnFuture); - } else { - LOG.debug("Tx {} dataExists: verifying {} previous recorded operations", - identifier, recordedOperationFutures.size()); - - // Note: we make a copy of recordedOperationFutures to be on the safe side in case - // Futures#sequence accesses the passed List on a different thread, as - // recordedOperationFutures is not synchronized. - - Future> combinedFutures = akka.dispatch.Futures.sequence( - Lists.newArrayList(recordedOperationFutures), - actorContext.getActorSystem().dispatcher()); - OnComplete> onComplete = new OnComplete>() { - @Override - public void onComplete(Throwable failure, Iterable notUsed) - throws Throwable { - if(failure != null) { - LOG.debug("Tx {} dataExists: a recorded operation failed: {}", - identifier, failure); - returnFuture.setException(new ReadFailedException( - "The data exists could not be performed because a previous " - + "put, merge, or delete operation failed", failure)); - } else { - finishDataExists(path, returnFuture); - } - } - }; - - combinedFutures.onComplete(onComplete, actorContext.getActorSystem().dispatcher()); - } - - return MappingCheckedFuture.create(returnFuture, ReadFailedException.MAPPER); - } - - private void finishDataExists(final YangInstanceIdentifier path, - final SettableFuture returnFuture) { - - LOG.debug("Tx {} finishDataExists called path = {}", identifier, path); - - OnComplete onComplete = new OnComplete() { - @Override - public void onComplete(Throwable failure, Object response) throws Throwable { - if(failure != null) { - LOG.debug("Tx {} dataExists operation failed: {}", identifier, failure); - returnFuture.setException(new ReadFailedException( - "Error checking data exists for path " + path, failure)); - } else { - LOG.debug("Tx {} dataExists operation succeeded", identifier, failure); - - if (response instanceof DataExistsReply) { - returnFuture.set(Boolean.valueOf(((DataExistsReply) response).exists())); - - } else if (response.getClass().equals(DataExistsReply.SERIALIZABLE_CLASS)) { - returnFuture.set(Boolean.valueOf(DataExistsReply.fromSerializable(response).exists())); - - } else { - returnFuture.setException(new ReadFailedException( - "Invalid response checking exists for path " + path)); - } - } - } - }; - - Future future = executeOperationAsync(new DataExists(path)); - - future.onComplete(onComplete, actorContext.getActorSystem().dispatcher()); - } - } - - private static class NoOpTransactionContext extends AbstractTransactionContext { - - private final Logger LOG = LoggerFactory.getLogger(NoOpTransactionContext.class); - - private final Throwable failure; - private final Semaphore operationLimiter; - - public NoOpTransactionContext(Throwable failure, TransactionIdentifier identifier, Semaphore operationLimiter){ - super(identifier); - this.failure = failure; - this.operationLimiter = operationLimiter; - } - - @Override - public void closeTransaction() { - LOG.debug("NoOpTransactionContext {} closeTransaction called", identifier); - } - - @Override - public Future readyTransaction() { - LOG.debug("Tx {} readyTransaction called", identifier); - operationLimiter.release(); - return akka.dispatch.Futures.failed(failure); - } - - @Override - public void deleteData(YangInstanceIdentifier path) { - LOG.debug("Tx {} deleteData called path = {}", identifier, path); - operationLimiter.release(); - } - - @Override - public void mergeData(YangInstanceIdentifier path, NormalizedNode data) { - LOG.debug("Tx {} mergeData called path = {}", identifier, path); - operationLimiter.release(); - } - - @Override - public void writeData(YangInstanceIdentifier path, NormalizedNode data) { - LOG.debug("Tx {} writeData called path = {}", identifier, path); - operationLimiter.release(); - } - - @Override - public CheckedFuture>, ReadFailedException> readData( - YangInstanceIdentifier path) { - LOG.debug("Tx {} readData called path = {}", identifier, path); - operationLimiter.release(); - return Futures.immediateFailedCheckedFuture(new ReadFailedException( - "Error reading data for path " + path, failure)); - } - - @Override - public CheckedFuture dataExists( - YangInstanceIdentifier path) { - LOG.debug("Tx {} dataExists called path = {}", identifier, path); - operationLimiter.release(); - return Futures.immediateFailedCheckedFuture(new ReadFailedException( - "Error checking exists for path " + path, failure)); - } - } - - private static class OperationCompleter extends OnComplete { - private final Semaphore operationLimiter; - OperationCompleter(Semaphore operationLimiter){ - this.operationLimiter = operationLimiter; - } - - @Override - public void onComplete(Throwable throwable, Object o){ - this.operationLimiter.release(); - } - } }