X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-dom-broker%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fmd%2Fsal%2Fdom%2Fbroker%2Fimpl%2FDOMForwardedWriteTransaction.java;h=87743046e122fbdf423db3b0faacae11e9ee5fa2;hp=5d4ad4d803ac90d75c3769b76ef5133e6283cf17;hb=7ab6f974861e01daa16ff56658eeb1be163cbfec;hpb=de3e413b633b7555ae8f3fe2ec163dbb7dda5da8 diff --git a/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/DOMForwardedWriteTransaction.java b/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/DOMForwardedWriteTransaction.java index 5d4ad4d803..87743046e1 100644 --- a/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/DOMForwardedWriteTransaction.java +++ b/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/DOMForwardedWriteTransaction.java @@ -7,10 +7,15 @@ */ package org.opendaylight.controller.md.sal.dom.broker.impl; -import static com.google.common.base.Preconditions.checkState; - -import javax.annotation.concurrent.GuardedBy; - +import com.google.common.base.Preconditions; +import com.google.common.util.concurrent.CheckedFuture; +import com.google.common.util.concurrent.Futures; +import com.google.common.util.concurrent.ListenableFuture; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Map; +import java.util.concurrent.Future; +import java.util.concurrent.atomic.AtomicReferenceFieldUpdater; import org.opendaylight.controller.md.sal.common.api.TransactionStatus; import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType; import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException; @@ -21,139 +26,140 @@ import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction; import org.opendaylight.yangtools.yang.common.RpcResult; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; - -import com.google.common.base.Preconditions; -import com.google.common.collect.ImmutableList; -import com.google.common.collect.ImmutableMap; -import com.google.common.util.concurrent.CheckedFuture; -import com.google.common.util.concurrent.ListenableFuture; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; /** - * - * * Read-Write Transaction, which is composed of several - * {@link DOMStoreWriteTransaction} transactions. Subtransaction is selected by + * {@link DOMStoreWriteTransaction} transactions. A sub-transaction is selected by * {@link LogicalDatastoreType} type parameter in: * + *

*

+ * *

* {@link #commit()} will result in invocation of - * {@link DOMDataCommitImplementation#submit(org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction, Iterable)} - * invocation with all {@link org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort} for underlying - * transactions. + * {@link DOMDataCommitImplementation#submit(org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction, + * Iterable)} invocation with all {@link org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort} + * for underlying transactions. * - * @param - * Subtype of {@link DOMStoreWriteTransaction} which is used as + * @param Subtype of {@link DOMStoreWriteTransaction} which is used as * subtransaction. */ class DOMForwardedWriteTransaction extends AbstractDOMForwardedCompositeTransaction implements DOMDataWriteTransaction { + @SuppressWarnings("rawtypes") + private static final AtomicReferenceFieldUpdater + IMPL_UPDATER = AtomicReferenceFieldUpdater + .newUpdater(DOMForwardedWriteTransaction.class, AbstractDOMForwardedTransactionFactory.class, "commitImpl"); + @SuppressWarnings("rawtypes") + private static final AtomicReferenceFieldUpdater FUTURE_UPDATER + = AtomicReferenceFieldUpdater.newUpdater(DOMForwardedWriteTransaction.class, Future.class, "commitFuture"); + private static final Logger LOG = LoggerFactory.getLogger(DOMForwardedWriteTransaction.class); + private static final Future CANCELLED_FUTURE = Futures.immediateCancelledFuture(); /** - * Implementation of real commit. - * - * Transaction can not be commited if commitImpl is null, - * so this seting this property to null is also used to - * prevent write to - * already commited / canceled transaction {@link #checkNotCanceled() - * - * + * Implementation of real commit. It also acts as an indication that + * the transaction is running -- which we flip atomically using + * {@link #IMPL_UPDATER}. */ - @GuardedBy("this") - private volatile DOMDataCommitImplementation commitImpl; + private volatile AbstractDOMForwardedTransactionFactory commitImpl; /** + * Future task of transaction commit. It starts off as null, but is + * set appropriately on {@link #submit()} and {@link #cancel()} via + * {@link AtomicReferenceFieldUpdater#lazySet(Object, Object)}. * - * Future task of transaction commit. - * - * This value is initially null, and is once updated if transaction - * is commited {@link #commit()}. - * If this future exists, transaction MUST not be commited again - * and all modifications should fail. See {@link #checkNotCommited()}. - * + *

+ * Lazy set is safe for use because it is only referenced to in the + * {@link #cancel()} slow path, where we will busy-wait for it. The + * fast path gets the benefit of a store-store barrier instead of the + * usual store-load barrier. */ - @GuardedBy("this") - private volatile CheckedFuture commitFuture; + private volatile Future commitFuture; - protected DOMForwardedWriteTransaction(final Object identifier, - final ImmutableMap backingTxs, final DOMDataCommitImplementation commitImpl) { + protected DOMForwardedWriteTransaction(final Object identifier, final Map backingTxs, + final AbstractDOMForwardedTransactionFactory commitImpl) { super(identifier, backingTxs); this.commitImpl = Preconditions.checkNotNull(commitImpl, "commitImpl must not be null."); } @Override - public void put(final LogicalDatastoreType store, final YangInstanceIdentifier path, final NormalizedNode data) { - checkNotReady(); + public void put(final LogicalDatastoreType store, final YangInstanceIdentifier path, + final NormalizedNode data) { + checkRunning(commitImpl); getSubtransaction(store).write(path, data); } @Override public void delete(final LogicalDatastoreType store, final YangInstanceIdentifier path) { - checkNotReady(); + checkRunning(commitImpl); getSubtransaction(store).delete(path); } @Override - public void merge(final LogicalDatastoreType store, final YangInstanceIdentifier path, final NormalizedNode data) { - checkNotReady(); + public void merge(final LogicalDatastoreType store, final YangInstanceIdentifier path, + final NormalizedNode data) { + checkRunning(commitImpl); getSubtransaction(store).merge(path, data); } @Override - public synchronized boolean cancel() { - // Transaction is already canceled, we are safe to return true - final boolean cancelationResult; - if (commitImpl == null && commitFuture != null) { - // Transaction is submitted, we try to cancel future. - cancelationResult = commitFuture.cancel(false); - } else if(commitImpl == null) { + public boolean cancel() { + final AbstractDOMForwardedTransactionFactory impl = IMPL_UPDATER.getAndSet(this, null); + if (impl != null) { + LOG.trace("Transaction {} cancelled before submit", getIdentifier()); + FUTURE_UPDATER.lazySet(this, CANCELLED_FUTURE); + closeSubtransactions(); return true; - } else { - cancelationResult = true; - commitImpl = null; } - return cancelationResult; + // The transaction is in process of being submitted or cancelled. Busy-wait + // for the corresponding future. + Future future; + do { + future = commitFuture; + } while (future == null); + + return future.cancel(false); } + @Deprecated @Override - public synchronized ListenableFuture> commit() { + public ListenableFuture> commit() { return AbstractDataTransaction.convertToLegacyCommitFuture(submit()); } @Override - public CheckedFuture submit() { - checkNotReady(); - - ImmutableList.Builder cohortsBuilder = ImmutableList.builder(); - for (DOMStoreWriteTransaction subTx : getSubtransactions()) { - cohortsBuilder.add(subTx.ready()); + @SuppressWarnings("checkstyle:illegalcatch") + public CheckedFuture submit() { + final AbstractDOMForwardedTransactionFactory impl = IMPL_UPDATER.getAndSet(this, null); + checkRunning(impl); + + final Collection txns = getSubtransactions(); + final Collection cohorts = new ArrayList<>(txns.size()); + + CheckedFuture ret; + try { + for (DOMStoreWriteTransaction txn : txns) { + cohorts.add(txn.ready()); + } + + ret = impl.submit(this, cohorts); + } catch (RuntimeException e) { + ret = Futures.immediateFailedCheckedFuture( + TransactionCommitFailedExceptionMapper.COMMIT_ERROR_MAPPER.apply(e)); } - ImmutableList cohorts = cohortsBuilder.build(); - commitFuture = commitImpl.submit(this, cohorts); - - /* - *We remove reference to Commit Implementation in order - *to prevent memory leak - */ - commitImpl = null; - return commitFuture; - } - - private void checkNotReady() { - checkNotCommited(); - checkNotCanceled(); - } - - private void checkNotCanceled() { - Preconditions.checkState(commitImpl != null, "Transaction was canceled."); + FUTURE_UPDATER.lazySet(this, ret); + return ret; } - private void checkNotCommited() { - checkState(commitFuture == null, "Transaction was already submited."); + private void checkRunning(final AbstractDOMForwardedTransactionFactory impl) { + Preconditions.checkState(impl != null, "Transaction %s is no longer running", getIdentifier()); } -} \ No newline at end of file +}