package org.opendaylight.controller.clustering.it.provider.impl;
-import com.google.common.util.concurrent.CheckedFuture;
-import com.google.common.util.concurrent.Futures;
+import com.google.common.base.Preconditions;
import com.google.common.util.concurrent.ListenableFuture;
import com.google.common.util.concurrent.SettableFuture;
-import java.util.ArrayList;
-import java.util.HashSet;
import java.util.LinkedHashSet;
-import java.util.List;
import java.util.Set;
import java.util.SplittableRandom;
+import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ExecutionException;
-import java.util.concurrent.Executors;
-import java.util.concurrent.ScheduledExecutorService;
-import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
+import java.util.concurrent.atomic.AtomicLong;
import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
import org.opendaylight.controller.md.sal.common.api.data.OptimisticLockFailedException;
import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.WriteTransactionsInput;
import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.WriteTransactionsOutput;
import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.WriteTransactionsOutputBuilder;
-import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.common.RpcError;
import org.opendaylight.yangtools.yang.common.RpcResult;
import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-public class WriteTransactionsHandler implements Runnable {
+public abstract class WriteTransactionsHandler extends AbstractTransactionHandler {
+ private static final class Chained extends WriteTransactionsHandler implements TransactionChainListener {
+ private final SplittableRandom random = new SplittableRandom();
+ private final DOMTransactionChain transactionChain;
- private static final Logger LOG = LoggerFactory.getLogger(WriteTransactionsHandler.class);
- private static final int SECOND_AS_NANO = 1000000000;
- //2^20 as in the model
- private static final int MAX_ITEM = 1048576;
-
- private static final QName ID_INTS =
- QName.create("tag:opendaylight.org,2017:controller:yang:lowlevel:target", "2017-02-15", "id-ints");
- private static final QName ID_INT =
- QName.create("tag:opendaylight.org,2017:controller:yang:lowlevel:target", "2017-02-15", "id-int");
- private static final QName ID =
- QName.create("tag:opendaylight.org,2017:controller:yang:lowlevel:target", "2017-02-15", "id");
- private static final QName ITEM =
- QName.create("tag:opendaylight.org,2017:controller:yang:lowlevel:target", "2017-02-15", "item");
- private static final QName NUMBER =
- QName.create("tag:opendaylight.org,2017:controller:yang:lowlevel:target", "2017-02-15", "number");
-
- public static final YangInstanceIdentifier ID_INTS_YID = YangInstanceIdentifier.of(ID_INTS);
- public static final YangInstanceIdentifier ID_INT_YID = ID_INTS_YID.node(ID_INT);
-
- private final DOMDataBroker domDataBroker;
- private final Long timeToTake;
- private final Long delay;
- private final String id;
- private final WriteTransactionsInput input;
-
- private final ScheduledExecutorService executor = Executors.newSingleThreadScheduledExecutor();
- private final ArrayList<CheckedFuture<Void, TransactionCommitFailedException>> futures = new ArrayList<>();
- private final Set<Integer> usedValues = new HashSet<>();
-
- private RandomnessProvider random;
- private TxProvider txProvider;
-
- private long startTime;
- private SettableFuture<RpcResult<WriteTransactionsOutput>> completionFuture;
-
- private long allTx = 0;
- private long insertTx = 0;
- private long deleteTx = 0;
- private ScheduledFuture<?> scheduledFuture;
- private YangInstanceIdentifier idListWithKey;
-
- public WriteTransactionsHandler(final DOMDataBroker domDataBroker, final WriteTransactionsInput input) {
- this.domDataBroker = domDataBroker;
- this.input = input;
-
- timeToTake = input.getSeconds() * SECOND_AS_NANO;
- delay = SECOND_AS_NANO / input.getTransactionsPerSecond();
- id = input.getId();
- }
+ Chained(final DOMDataBroker dataBroker, final YangInstanceIdentifier idListItem,
+ final WriteTransactionsInput input) {
+ super(idListItem, input);
+ transactionChain = dataBroker.createTransactionChain(this);
+ }
- @Override
- public void run() {
- final long current = System.nanoTime();
+ @Override
+ DOMDataWriteTransaction createTransaction() {
+ return transactionChain.newWriteOnlyTransaction();
+ }
- futures.add(execWrite());
+ @Override
+ int nextInt(final int bound) {
+ return random.nextInt(bound);
+ }
- maybeFinish(current);
+ @Override
+ public void onTransactionChainFailed(final TransactionChain<?, ?> chain,
+ final AsyncTransaction<?, ?> transaction, final Throwable cause) {
+ // This is expected to happen frequently in isolation testing.
+ LOG.debug("Transaction chain failed.", cause);
+ // Do not return RPC here, rely on transaction failure to call runFailed.
+ }
+
+ @Override
+ public void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
+ LOG.debug("Transaction chain closed successfully.");
+ }
}
- public void start(final SettableFuture<RpcResult<WriteTransactionsOutput>> settableFuture) {
- LOG.debug("Starting write-transactions.");
+ private static final class Simple extends WriteTransactionsHandler {
+ private final LinkedHashSet<Integer> previousNumbers = new LinkedHashSet<>();
+ private final SplittableRandom random = new SplittableRandom();
+ private final DOMDataBroker dataBroker;
- if (input.isChainedTransactions()) {
- txProvider = new TxChainBackedProvider(domDataBroker, settableFuture, executor);
- random = new BasicProvider();
- } else {
- txProvider = new DataBrokerBackedProvider(domDataBroker);
- random = new NonConflictingProvider();
+ Simple(final DOMDataBroker dataBroker, final YangInstanceIdentifier idListItem,
+ final WriteTransactionsInput input) {
+ super(idListItem, input);
+ this.dataBroker = Preconditions.checkNotNull(dataBroker);
}
- if (ensureListExists(settableFuture) && fillInitialList(settableFuture)) {
- startTime = System.nanoTime();
- completionFuture = settableFuture;
- scheduledFuture = executor.scheduleAtFixedRate(this, 0, delay, TimeUnit.NANOSECONDS);
- } else {
- executor.shutdown();
+ @Override
+ DOMDataWriteTransaction createTransaction() {
+ return dataBroker.newWriteOnlyTransaction();
+ }
+
+ @Override
+ int nextInt(final int bound) {
+ int nextInt;
+ do {
+ nextInt = random.nextInt(bound);
+ } while (previousNumbers.contains(nextInt));
+
+ if (previousNumbers.size() > 100000) {
+ previousNumbers.iterator().remove();
+ }
+ previousNumbers.add(nextInt);
+
+ return nextInt;
}
}
- private boolean ensureListExists(final SettableFuture<RpcResult<WriteTransactionsOutput>> settableFuture) {
+ private static final Logger LOG = LoggerFactory.getLogger(WriteTransactionsHandler.class);
+
+ final SettableFuture<RpcResult<WriteTransactionsOutput>> completionFuture = SettableFuture.create();
+ private final Set<Integer> usedValues = ConcurrentHashMap.newKeySet();
+ private final YangInstanceIdentifier idListItem;
+
+ private final AtomicLong insertTx = new AtomicLong();
+ private final AtomicLong deleteTx = new AtomicLong();
+
+ WriteTransactionsHandler(final YangInstanceIdentifier idListItem, final WriteTransactionsInput input) {
+ super(input);
+ this.idListItem = Preconditions.checkNotNull(idListItem);
+ }
+
+ public static ListenableFuture<RpcResult<WriteTransactionsOutput>> start(final DOMDataBroker domDataBroker,
+ final WriteTransactionsInput input) {
+ LOG.info("Starting write transactions with input {}", input);
+
+ final String id = input.getId();
+ final MapEntryNode entry = ImmutableNodes.mapEntryBuilder(ID_INT, ID, id)
+ .withChild(ImmutableNodes.mapNodeBuilder(ITEM).build())
+ .build();
+ final YangInstanceIdentifier idListItem = ID_INT_YID.node(entry.getIdentifier());
final ContainerNode containerNode = ImmutableContainerNodeBuilder.create()
.withNodeIdentifier(new NodeIdentifier(ID_INTS))
.withChild(ImmutableNodes.mapNodeBuilder(ID_INT).build())
.build();
- DOMDataWriteTransaction tx = txProvider.createTransaction();
+ DOMDataWriteTransaction tx = domDataBroker.newWriteOnlyTransaction();
// write only the top list
tx.merge(LogicalDatastoreType.CONFIGURATION, ID_INTS_YID, containerNode);
try {
- tx.submit().checkedGet(125, TimeUnit.SECONDS);
+ tx.submit().checkedGet(INIT_TX_TIMEOUT_SECONDS, TimeUnit.SECONDS);
} catch (final OptimisticLockFailedException e) {
// when multiple write-transactions are executed concurrently we need to ignore this.
// If we get optimistic lock here it means id-ints already exists and we can continue.
LOG.debug("Got an optimistic lock when writing initial top level list element.", e);
} catch (final TransactionCommitFailedException | TimeoutException e) {
- LOG.warn("Unable to ensure IdInts list for id: {} exists.", id, e);
- settableFuture.set(RpcResultBuilder.<WriteTransactionsOutput>failed()
- .withError(RpcError.ErrorType.APPLICATION, "Unexpected-exception", e).build());
- return false;
+ LOG.error("Error writing top-level path {}: {}", ID_INTS_YID, containerNode, e);
+ return RpcResultBuilder.<WriteTransactionsOutput>failed().withError(RpcError.ErrorType.APPLICATION,
+ String.format("Could not start write transactions - error writing top-level path %s: %s",
+ ID_INTS_YID, containerNode), e).buildFuture();
}
- final MapEntryNode entry = ImmutableNodes.mapEntryBuilder(ID_INT, ID, id)
- .withChild(ImmutableNodes.mapNodeBuilder(ITEM).build())
- .build();
-
- idListWithKey = ID_INT_YID.node(entry.getIdentifier());
- tx = txProvider.createTransaction();
- tx.merge(LogicalDatastoreType.CONFIGURATION, idListWithKey, entry);
+ tx = domDataBroker.newWriteOnlyTransaction();
+ tx.merge(LogicalDatastoreType.CONFIGURATION, idListItem, entry);
try {
- tx.submit().checkedGet(125, TimeUnit.SECONDS);
- } catch (final Exception e) {
- LOG.warn("Unable to ensure IdInts list for id: {} exists.", id, e);
- settableFuture.set(RpcResultBuilder.<WriteTransactionsOutput>failed()
- .withError(RpcError.ErrorType.APPLICATION, "Unexpected-exception", e).build());
- return false;
+ tx.submit().get(INIT_TX_TIMEOUT_SECONDS, TimeUnit.SECONDS);
+ } catch (InterruptedException | ExecutionException | TimeoutException e) {
+ LOG.error("Error writing top-level path {}: {}", idListItem, entry, e);
+ return RpcResultBuilder.<WriteTransactionsOutput>failed().withError(RpcError.ErrorType.APPLICATION,
+ String.format("Could not start write transactions - error writing list entry path %s: %s",
+ idListItem, entry), e).buildFuture();
}
- return true;
- }
-
- private boolean fillInitialList(final SettableFuture<RpcResult<WriteTransactionsOutput>> settableFuture) {
LOG.debug("Filling the item list with initial values.");
final CollectionNodeBuilder<MapEntryNode, MapNode> mapBuilder = ImmutableNodes.mapNodeBuilder(ITEM);
- final YangInstanceIdentifier itemListId = idListWithKey.node(ITEM);
- final DOMDataWriteTransaction tx = txProvider.createTransaction();
- tx.put(LogicalDatastoreType.CONFIGURATION, itemListId, mapBuilder.build());
+ final YangInstanceIdentifier itemListId = idListItem.node(ITEM);
+ tx = domDataBroker.newWriteOnlyTransaction();
+ final MapNode itemListNode = mapBuilder.build();
+ tx.put(LogicalDatastoreType.CONFIGURATION, itemListId, itemListNode);
try {
- tx.submit().checkedGet(125, TimeUnit.SECONDS);
- } catch (final Exception e) {
- LOG.warn("Unable to fill the initial item list.", e);
- settableFuture.set(RpcResultBuilder.<WriteTransactionsOutput>failed()
- .withError(RpcError.ErrorType.APPLICATION, "Unexpected-exception", e).build());
- return false;
+ tx.submit().get(INIT_TX_TIMEOUT_SECONDS, TimeUnit.SECONDS);
+ } catch (InterruptedException | ExecutionException | TimeoutException e) {
+ LOG.error("Error filling initial item list path {}: {}", itemListId, itemListNode, e);
+ return RpcResultBuilder.<WriteTransactionsOutput>failed().withError(RpcError.ErrorType.APPLICATION,
+ String.format("Could not start write transactions - error filling initial item list path %s: %s",
+ itemListId, itemListNode), e).buildFuture();
+ }
+
+ final WriteTransactionsHandler handler;
+ if (input.isChainedTransactions()) {
+ handler = new Chained(domDataBroker, idListItem, input);
+ } else {
+ handler = new Simple(domDataBroker, idListItem, input);
}
- return true;
+ handler.doStart();
+
+ LOG.info("Write transactions successfully started");
+ return handler.completionFuture;
}
- private CheckedFuture<Void, TransactionCommitFailedException> execWrite() {
- final int i = random.nextInt(MAX_ITEM + 1);
+ @Override
+ ListenableFuture<Void> execWrite(final long txId) {
+ final int i = nextInt(MAX_ITEM + 1);
final YangInstanceIdentifier entryId =
- idListWithKey.node(ITEM).node(new YangInstanceIdentifier.NodeIdentifierWithPredicates(ITEM, NUMBER, i));
+ idListItem.node(ITEM).node(new YangInstanceIdentifier.NodeIdentifierWithPredicates(ITEM, NUMBER, i));
- final DOMDataWriteTransaction tx = txProvider.createTransaction();
- allTx++;
+ final DOMDataWriteTransaction tx = createTransaction();
if (usedValues.contains(i)) {
LOG.debug("Deleting item: {}", i);
- deleteTx++;
+ deleteTx.incrementAndGet();
tx.delete(LogicalDatastoreType.CONFIGURATION, entryId);
usedValues.remove(i);
} else {
LOG.debug("Inserting item: {}", i);
- insertTx++;
+ insertTx.incrementAndGet();
final MapEntryNode entry = ImmutableNodes.mapEntry(ITEM, NUMBER, i);
tx.put(LogicalDatastoreType.CONFIGURATION, entryId, entry);
usedValues.add(i);
return tx.submit();
}
- private void maybeFinish(final long current) {
- if ((current - startTime) > timeToTake) {
- LOG.debug("Reached max running time, waiting for futures to complete.");
- scheduledFuture.cancel(false);
-
- final ListenableFuture<List<Void>> allFutures = Futures.allAsList(futures);
-
- try {
- // Timeout from cds should be 2 minutes so leave some leeway.
- allFutures.get(125, TimeUnit.SECONDS);
-
- LOG.debug("All futures completed successfully.");
-
- final WriteTransactionsOutput output = new WriteTransactionsOutputBuilder()
- .setAllTx(allTx)
- .setInsertTx(insertTx)
- .setDeleteTx(deleteTx)
- .build();
-
- completionFuture.set(RpcResultBuilder.<WriteTransactionsOutput>success()
- .withResult(output).build());
-
- executor.shutdown();
- } catch (Exception exception) {
- LOG.error("Write transactions failed.", exception);
- completionFuture.set(RpcResultBuilder.<WriteTransactionsOutput>failed()
- .withError(RpcError.ErrorType.APPLICATION, "Unexpected-exception", exception).build());
-
- for (int i = 0; i < futures.size(); i++) {
- final CheckedFuture<Void, TransactionCommitFailedException> future = futures.get(i);
- if (!future.isDone()) {
- LOG.warn("Future #{}/{} possibly hanged.", future, futures.size());
- }
- }
-
- executor.shutdown();
- }
- }
- }
-
- private interface RandomnessProvider {
- int nextInt(int bound);
- }
-
- private static class NonConflictingProvider implements RandomnessProvider {
-
- private final SplittableRandom random = new SplittableRandom();
- private final LinkedHashSet<Integer> previousNumbers = new LinkedHashSet<>();
-
- @Override
- public int nextInt(int bound) {
- int nextInt;
- do {
- nextInt = random.nextInt(bound);
- } while (previousNumbers.contains(nextInt));
-
- if (previousNumbers.size() > 100000) {
- previousNumbers.iterator().remove();
- }
- previousNumbers.add(nextInt);
-
- return nextInt;
- }
- }
-
- private static class BasicProvider implements RandomnessProvider {
-
- private final SplittableRandom random = new SplittableRandom();
-
- @Override
- public int nextInt(int bound) {
- return random.nextInt(bound);
- }
- }
-
- private interface TxProvider {
-
- DOMDataWriteTransaction createTransaction();
+ @Override
+ void runFailed(final Throwable cause, final long txId) {
+ completionFuture.set(RpcResultBuilder.<WriteTransactionsOutput>failed()
+ .withError(RpcError.ErrorType.APPLICATION, "Commit failed for tx # " + txId, cause).build());
}
- private static class TxChainBackedProvider implements TxProvider {
-
- private final DOMTransactionChain transactionChain;
-
- TxChainBackedProvider(final DOMDataBroker dataBroker,
- final SettableFuture<RpcResult<WriteTransactionsOutput>> completionFuture,
- final ScheduledExecutorService executor) {
-
- transactionChain =
- dataBroker.createTransactionChain(new TestChainListener(completionFuture, executor));
- }
+ @Override
+ void runSuccessful(final long allTx) {
+ final WriteTransactionsOutput output = new WriteTransactionsOutputBuilder()
+ .setAllTx(allTx)
+ .setInsertTx(insertTx.get())
+ .setDeleteTx(deleteTx.get())
+ .build();
- @Override
- public DOMDataWriteTransaction createTransaction() {
- return transactionChain.newWriteOnlyTransaction();
- }
+ completionFuture.set(RpcResultBuilder.<WriteTransactionsOutput>success()
+ .withResult(output).build());
}
- private static class DataBrokerBackedProvider implements TxProvider {
-
- private final DOMDataBroker dataBroker;
-
- DataBrokerBackedProvider(final DOMDataBroker dataBroker) {
- this.dataBroker = dataBroker;
- }
-
- @Override
- public DOMDataWriteTransaction createTransaction() {
- return dataBroker.newWriteOnlyTransaction();
- }
+ @Override
+ void runTimedOut(final String cause) {
+ completionFuture.set(RpcResultBuilder.<WriteTransactionsOutput>failed()
+ .withError(RpcError.ErrorType.APPLICATION, cause).build());
}
- private static class TestChainListener implements TransactionChainListener {
-
- private final SettableFuture<RpcResult<WriteTransactionsOutput>> resultFuture;
- private final ScheduledExecutorService executor;
-
- TestChainListener(final SettableFuture<RpcResult<WriteTransactionsOutput>> resultFuture,
- final ScheduledExecutorService executor) {
+ abstract DOMDataWriteTransaction createTransaction();
- this.resultFuture = resultFuture;
- this.executor = executor;
- }
-
- @Override
- public void onTransactionChainFailed(final TransactionChain<?, ?> chain,
- final AsyncTransaction<?, ?> transaction,
- final Throwable cause) {
- LOG.warn("Transaction chain failed.", cause);
- resultFuture.set(RpcResultBuilder.<WriteTransactionsOutput>failed()
- .withError(RpcError.ErrorType.APPLICATION, "Unexpected-exception", cause).build());
-
- executor.shutdown();
- }
-
- @Override
- public void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
- LOG.debug("Transaction chain closed successfully.");
- }
- }
+ abstract int nextInt(int bound);
}
Code Review / controller.git / blobdiff