/*
* Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* 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.md.sal.dom.broker.impl;
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;
import org.opendaylight.controller.md.sal.common.impl.service.AbstractDataTransaction;
import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
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 org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Read-Write Transaction, which is composed of several
* {@link DOMStoreWriteTransaction} transactions. A sub-transaction is selected by
* {@link LogicalDatastoreType} type parameter in:
*
*
* - {@link #put(LogicalDatastoreType, YangInstanceIdentifier, NormalizedNode)}
*
- {@link #delete(LogicalDatastoreType, YangInstanceIdentifier)}
*
- {@link #merge(LogicalDatastoreType, YangInstanceIdentifier, NormalizedNode)}
*
*
* {@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.
*
* @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. It also acts as an indication that
* the transaction is running -- which we flip atomically using
* {@link #IMPL_UPDATER}.
*/
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)}.
*
* 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.
*/
private volatile Future> commitFuture;
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) {
checkRunning(commitImpl);
getSubtransaction(store).write(path, data);
}
@Override
public void delete(final LogicalDatastoreType store, final YangInstanceIdentifier path) {
checkRunning(commitImpl);
getSubtransaction(store).delete(path);
}
@Override
public void merge(final LogicalDatastoreType store, final YangInstanceIdentifier path, final NormalizedNode, ?> data) {
checkRunning(commitImpl);
getSubtransaction(store).merge(path, data);
}
@Override
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;
}
// 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 ListenableFuture> commit() {
return AbstractDataTransaction.convertToLegacyCommitFuture(submit());
}
@Override
public CheckedFuture submit() {
final AbstractDOMForwardedTransactionFactory> impl = IMPL_UPDATER.getAndSet(this, null);
checkRunning(impl);
final Collection txns = getSubtransactions();
final Collection cohorts = new ArrayList<>(txns.size());
// FIXME: deal with errors thrown by backed (ready and submit can fail in theory)
for (DOMStoreWriteTransaction txn : txns) {
cohorts.add(txn.ready());
}
final CheckedFuture ret = impl.submit(this, cohorts);
FUTURE_UPDATER.lazySet(this, ret);
return ret;
}
private void checkRunning(final AbstractDOMForwardedTransactionFactory> impl) {
Preconditions.checkState(impl != null, "Transaction %s is no longer running", getIdentifier());
}
}