Do not leak DataTree from backend actor
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / TransactionChainProxy.java
index d230a956c250d0bb359c2889bffa18ac4346d48f..c3b81d7e15730c338669757e22338ef816938ee1 100644 (file)
@@ -17,19 +17,17 @@ import java.util.List;
 import java.util.Map.Entry;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ConcurrentMap;
-import java.util.concurrent.atomic.AtomicInteger;
 import java.util.concurrent.atomic.AtomicReferenceFieldUpdater;
-import javax.annotation.Nonnull;
-import org.opendaylight.controller.cluster.datastore.identifiers.TransactionChainIdentifier;
-import org.opendaylight.controller.cluster.datastore.identifiers.TransactionIdentifier;
+import org.opendaylight.controller.cluster.access.concepts.LocalHistoryIdentifier;
+import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
 import org.opendaylight.controller.cluster.datastore.messages.CloseTransactionChain;
 import org.opendaylight.controller.cluster.datastore.messages.PrimaryShardInfo;
-import org.opendaylight.controller.md.sal.common.api.data.TransactionChainClosedException;
-import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction;
-import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadWriteTransaction;
-import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionChain;
-import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction;
-import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
+import org.opendaylight.mdsal.dom.api.DOMTransactionChainClosedException;
+import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadTransaction;
+import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadWriteTransaction;
+import org.opendaylight.mdsal.dom.spi.store.DOMStoreTransactionChain;
+import org.opendaylight.mdsal.dom.spi.store.DOMStoreWriteTransaction;
+import org.opendaylight.yangtools.yang.data.api.schema.tree.ReadOnlyDataTree;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import scala.concurrent.Future;
@@ -40,8 +38,9 @@ import scala.concurrent.Promise;
  * at a time. For remote transactions, it also tracks the outstanding readiness requests
  * towards the shard and unblocks operations only after all have completed.
  */
-final class TransactionChainProxy extends AbstractTransactionContextFactory<LocalTransactionChain> implements DOMStoreTransactionChain {
-    private static abstract class State {
+final class TransactionChainProxy extends AbstractTransactionContextFactory<LocalTransactionChain>
+        implements DOMStoreTransactionChain {
+    private abstract static class State {
         /**
          * Check if it is okay to allocate a new transaction.
          * @throws IllegalStateException if a transaction may not be allocated.
@@ -56,7 +55,7 @@ final class TransactionChainProxy extends AbstractTransactionContextFactory<Loca
         abstract Future<?> previousFuture();
     }
 
-    private static abstract class Pending extends State {
+    private abstract static class Pending extends State {
         private final TransactionIdentifier transaction;
         private final Future<?> previousFuture;
 
@@ -97,7 +96,7 @@ final class TransactionChainProxy extends AbstractTransactionContextFactory<Loca
         }
     }
 
-    private static abstract class DefaultState extends State {
+    private abstract static class DefaultState extends State {
         @Override
         final Future<?> previousFuture() {
             return null;
@@ -114,16 +113,14 @@ final class TransactionChainProxy extends AbstractTransactionContextFactory<Loca
     private static final State CLOSED_STATE = new DefaultState() {
         @Override
         void checkReady() {
-            throw new TransactionChainClosedException("Transaction chain has been closed");
+            throw new DOMTransactionChainClosedException("Transaction chain has been closed");
         }
     };
 
     private static final Logger LOG = LoggerFactory.getLogger(TransactionChainProxy.class);
-    private static final AtomicInteger CHAIN_COUNTER = new AtomicInteger();
     private static final AtomicReferenceFieldUpdater<TransactionChainProxy, State> STATE_UPDATER =
             AtomicReferenceFieldUpdater.newUpdater(TransactionChainProxy.class, State.class, "currentState");
 
-    private final TransactionChainIdentifier transactionChainId;
     private final TransactionContextFactory parent;
     private volatile State currentState = IDLE_STATE;
 
@@ -131,34 +128,29 @@ final class TransactionChainProxy extends AbstractTransactionContextFactory<Loca
      * This map holds Promise instances for each read-only tx. It is used to maintain ordering of tx creates
      * wrt to read-only tx's between this class and a LocalTransactionChain since they're bridged by
      * asynchronous futures. Otherwise, in the following scenario, eg:
-     *
+     * <p/>
      *   1) Create write tx1 on chain
      *   2) do write and submit
      *   3) Create read-only tx2 on chain and issue read
      *   4) Create write tx3 on chain, do write but do not submit
-     *
+     * <p/>
      * if the sequence/timing is right, tx3 may create its local tx on the LocalTransactionChain before tx2,
      * which results in tx2 failing b/c tx3 isn't ready yet. So maintaining ordering prevents this issue
      * (see Bug 4774).
-     * <p>
+     * <p/>
      * A Promise is added via newReadOnlyTransaction. When the parent class completes the primary shard
      * lookup and creates the TransactionContext (either success or failure), onTransactionContextCreated is
      * called which completes the Promise. A write tx that is created prior to completion will wait on the
      * Promise's Future via findPrimaryShard.
      */
-    private final ConcurrentMap<TransactionIdentifier, Promise<Object>> priorReadOnlyTxPromises = new ConcurrentHashMap<>();
+    private final ConcurrentMap<TransactionIdentifier, Promise<Object>> priorReadOnlyTxPromises =
+            new ConcurrentHashMap<>();
 
-    TransactionChainProxy(final TransactionContextFactory parent) {
-        super(parent.getActorContext());
-
-        transactionChainId = new TransactionChainIdentifier(parent.getActorContext().getCurrentMemberName(), CHAIN_COUNTER.incrementAndGet());
+    TransactionChainProxy(final TransactionContextFactory parent, final LocalHistoryIdentifier historyId) {
+        super(parent.getActorUtils(), historyId);
         this.parent = parent;
     }
 
-    public String getTransactionChainId() {
-        return transactionChainId.toString();
-    }
-
     @Override
     public DOMStoreReadTransaction newReadOnlyTransaction() {
         currentState.checkReady();
@@ -169,13 +161,13 @@ final class TransactionChainProxy extends AbstractTransactionContextFactory<Loca
 
     @Override
     public DOMStoreReadWriteTransaction newReadWriteTransaction() {
-        getActorContext().acquireTxCreationPermit();
+        getActorUtils().acquireTxCreationPermit();
         return allocateWriteTransaction(TransactionType.READ_WRITE);
     }
 
     @Override
     public DOMStoreWriteTransaction newWriteOnlyTransaction() {
-        getActorContext().acquireTxCreationPermit();
+        getActorUtils().acquireTxCreationPermit();
         return allocateWriteTransaction(TransactionType.WRITE_ONLY);
     }
 
@@ -184,7 +176,9 @@ final class TransactionChainProxy extends AbstractTransactionContextFactory<Loca
         currentState = CLOSED_STATE;
 
         // Send a close transaction chain request to each and every shard
-        getActorContext().broadcast(new CloseTransactionChain(transactionChainId.toString()).toSerializable());
+
+        getActorUtils().broadcast(version -> new CloseTransactionChain(getHistoryId(), version).toSerializable(),
+                CloseTransactionChain.class);
     }
 
     private TransactionProxy allocateWriteTransaction(final TransactionType type) {
@@ -197,7 +191,8 @@ final class TransactionChainProxy extends AbstractTransactionContextFactory<Loca
     }
 
     @Override
-    protected LocalTransactionChain factoryForShard(final String shardName, final ActorSelection shardLeader, final DataTree dataTree) {
+    protected LocalTransactionChain factoryForShard(final String shardName, final ActorSelection shardLeader,
+            final ReadOnlyDataTree dataTree) {
         final LocalTransactionChain ret = new LocalTransactionChain(this, shardLeader, dataTree);
         LOG.debug("Allocated transaction chain {} for shard {} leader {}", ret, shardName, shardLeader);
         return ret;
@@ -222,12 +217,12 @@ final class TransactionChainProxy extends AbstractTransactionContextFactory<Loca
 
         final String previousTransactionId;
 
-        if(localState instanceof Pending){
+        if (localState instanceof Pending) {
             previousTransactionId = ((Pending) localState).getIdentifier().toString();
             LOG.debug("Tx: {} - waiting for ready futures with pending Tx {}", txId, previousTransactionId);
         } else {
             previousTransactionId = "";
-            LOG.debug("Waiting for ready futures on chain {}", getTransactionChainId());
+            LOG.debug("Waiting for ready futures on chain {}", getHistoryId());
         }
 
         previous = combineFutureWithPossiblePriorReadOnlyTxFutures(previous, txId);
@@ -253,27 +248,27 @@ final class TransactionChainProxy extends AbstractTransactionContextFactory<Loca
             }
         };
 
-        previous.onComplete(onComplete, getActorContext().getClientDispatcher());
+        previous.onComplete(onComplete, getActorUtils().getClientDispatcher());
         return returnPromise.future();
     }
 
     private <T> Future<T> combineFutureWithPossiblePriorReadOnlyTxFutures(final Future<T> future,
             final TransactionIdentifier txId) {
-        if(!priorReadOnlyTxPromises.containsKey(txId) && !priorReadOnlyTxPromises.isEmpty()) {
+        if (!priorReadOnlyTxPromises.containsKey(txId) && !priorReadOnlyTxPromises.isEmpty()) {
             Collection<Entry<TransactionIdentifier, Promise<Object>>> priorReadOnlyTxPromiseEntries =
                     new ArrayList<>(priorReadOnlyTxPromises.entrySet());
-            if(priorReadOnlyTxPromiseEntries.isEmpty()) {
+            if (priorReadOnlyTxPromiseEntries.isEmpty()) {
                 return future;
             }
 
             List<Future<Object>> priorReadOnlyTxFutures = new ArrayList<>(priorReadOnlyTxPromiseEntries.size());
-            for(Entry<TransactionIdentifier, Promise<Object>> entry: priorReadOnlyTxPromiseEntries) {
+            for (Entry<TransactionIdentifier, Promise<Object>> entry: priorReadOnlyTxPromiseEntries) {
                 LOG.debug("Tx: {} - waiting on future for prior read-only Tx {}", txId, entry.getKey());
                 priorReadOnlyTxFutures.add(entry.getValue().future());
             }
 
             Future<Iterable<Object>> combinedFutures = Futures.sequence(priorReadOnlyTxFutures,
-                    getActorContext().getClientDispatcher());
+                    getActorUtils().getClientDispatcher());
 
             final Promise<T> returnPromise = Futures.promise();
             final OnComplete<Iterable<Object>> onComplete = new OnComplete<Iterable<Object>>() {
@@ -286,7 +281,7 @@ final class TransactionChainProxy extends AbstractTransactionContextFactory<Loca
                 }
             };
 
-            combinedFutures.onComplete(onComplete, getActorContext().getClientDispatcher());
+            combinedFutures.onComplete(onComplete, getActorUtils().getClientDispatcher());
             return returnPromise.future();
         } else {
             return future;
@@ -294,11 +289,14 @@ final class TransactionChainProxy extends AbstractTransactionContextFactory<Loca
     }
 
     @Override
-    protected <T> void onTransactionReady(final TransactionIdentifier transaction, final Collection<Future<T>> cohortFutures) {
+    protected <T> void onTransactionReady(final TransactionIdentifier transaction,
+            final Collection<Future<T>> cohortFutures) {
         final State localState = currentState;
-        Preconditions.checkState(localState instanceof Allocated, "Readying transaction %s while state is %s", transaction, localState);
+        Preconditions.checkState(localState instanceof Allocated, "Readying transaction %s while state is %s",
+                transaction, localState);
         final TransactionIdentifier currentTx = ((Allocated)localState).getIdentifier();
-        Preconditions.checkState(transaction.equals(currentTx), "Readying transaction %s while %s is allocated", transaction, currentTx);
+        Preconditions.checkState(transaction.equals(currentTx), "Readying transaction %s while %s is allocated",
+                transaction, currentTx);
 
         // Transaction ready and we are not waiting for futures -- go to idle
         if (cohortFutures.isEmpty()) {
@@ -307,7 +305,7 @@ final class TransactionChainProxy extends AbstractTransactionContextFactory<Loca
         }
 
         // Combine the ready Futures into 1
-        final Future<Iterable<T>> combined = Futures.sequence(cohortFutures, getActorContext().getClientDispatcher());
+        final Future<Iterable<T>> combined = Futures.sequence(cohortFutures, getActorUtils().getClientDispatcher());
 
         // Record the we have outstanding futures
         final State newState = new Submitted(transaction, combined);
@@ -320,19 +318,14 @@ final class TransactionChainProxy extends AbstractTransactionContextFactory<Loca
             public void onComplete(final Throwable arg0, final Iterable<T> arg1) {
                 STATE_UPDATER.compareAndSet(TransactionChainProxy.this, newState, IDLE_STATE);
             }
-        }, getActorContext().getClientDispatcher());
+        }, getActorUtils().getClientDispatcher());
     }
 
     @Override
-    protected void onTransactionContextCreated(@Nonnull TransactionIdentifier transactionId) {
+    protected void onTransactionContextCreated(TransactionIdentifier transactionId) {
         Promise<Object> promise = priorReadOnlyTxPromises.remove(transactionId);
-        if(promise != null) {
+        if (promise != null) {
             promise.success(null);
         }
     }
-
-    @Override
-    protected TransactionIdentifier nextIdentifier() {
-        return transactionChainId.newTransactionIdentifier();
-    }
 }