2 * Copyright (c) 2017 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.controller.clustering.it.provider.impl;
10 import static java.util.Objects.requireNonNull;
12 import com.google.common.util.concurrent.ListenableFuture;
13 import com.google.common.util.concurrent.SettableFuture;
14 import java.util.LinkedHashSet;
16 import java.util.SplittableRandom;
17 import java.util.concurrent.ConcurrentHashMap;
18 import java.util.concurrent.ExecutionException;
19 import java.util.concurrent.TimeUnit;
20 import java.util.concurrent.TimeoutException;
21 import java.util.concurrent.atomic.AtomicLong;
22 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
23 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
24 import org.opendaylight.controller.md.sal.common.api.data.OptimisticLockFailedException;
25 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
26 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
27 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
28 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
29 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
30 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
31 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.WriteTransactionsInput;
32 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.WriteTransactionsOutput;
33 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.WriteTransactionsOutputBuilder;
34 import org.opendaylight.yangtools.yang.common.RpcError;
35 import org.opendaylight.yangtools.yang.common.RpcResult;
36 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
37 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
38 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
39 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
40 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
41 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
42 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
43 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
44 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
45 import org.slf4j.Logger;
46 import org.slf4j.LoggerFactory;
48 public abstract class WriteTransactionsHandler extends AbstractTransactionHandler {
49 private static final class Chained extends WriteTransactionsHandler implements TransactionChainListener {
50 private final SplittableRandom random = new SplittableRandom();
51 private final DOMTransactionChain transactionChain;
53 Chained(final DOMDataBroker dataBroker, final YangInstanceIdentifier idListItem,
54 final WriteTransactionsInput input) {
55 super(idListItem, input);
56 transactionChain = dataBroker.createTransactionChain(this);
60 DOMDataWriteTransaction createTransaction() {
61 return transactionChain.newWriteOnlyTransaction();
65 int nextInt(final int bound) {
66 return random.nextInt(bound);
70 public void onTransactionChainFailed(final TransactionChain<?, ?> chain,
71 final AsyncTransaction<?, ?> transaction, final Throwable cause) {
72 // This is expected to happen frequently in isolation testing.
73 LOG.debug("Transaction chain failed.", cause);
74 // Do not return RPC here, rely on transaction failure to call runFailed.
78 public void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
79 LOG.debug("Transaction chain closed successfully.");
83 private static final class Simple extends WriteTransactionsHandler {
84 private final LinkedHashSet<Integer> previousNumbers = new LinkedHashSet<>();
85 private final SplittableRandom random = new SplittableRandom();
86 private final DOMDataBroker dataBroker;
88 Simple(final DOMDataBroker dataBroker, final YangInstanceIdentifier idListItem,
89 final WriteTransactionsInput input) {
90 super(idListItem, input);
91 this.dataBroker = requireNonNull(dataBroker);
95 DOMDataWriteTransaction createTransaction() {
96 return dataBroker.newWriteOnlyTransaction();
100 int nextInt(final int bound) {
103 nextInt = random.nextInt(bound);
104 } while (previousNumbers.contains(nextInt));
106 if (previousNumbers.size() > 100000) {
107 previousNumbers.iterator().remove();
109 previousNumbers.add(nextInt);
115 private static final Logger LOG = LoggerFactory.getLogger(WriteTransactionsHandler.class);
117 final SettableFuture<RpcResult<WriteTransactionsOutput>> completionFuture = SettableFuture.create();
118 private final Set<Integer> usedValues = ConcurrentHashMap.newKeySet();
119 private final YangInstanceIdentifier idListItem;
121 private final AtomicLong insertTx = new AtomicLong();
122 private final AtomicLong deleteTx = new AtomicLong();
124 WriteTransactionsHandler(final YangInstanceIdentifier idListItem, final WriteTransactionsInput input) {
126 this.idListItem = requireNonNull(idListItem);
129 public static ListenableFuture<RpcResult<WriteTransactionsOutput>> start(final DOMDataBroker domDataBroker,
130 final WriteTransactionsInput input) {
131 LOG.info("Starting write transactions with input {}", input);
133 final String id = input.getId();
134 final MapEntryNode entry = ImmutableNodes.mapEntryBuilder(ID_INT, ID, id)
135 .withChild(ImmutableNodes.mapNodeBuilder(ITEM).build())
137 final YangInstanceIdentifier idListItem = ID_INT_YID.node(entry.getIdentifier());
139 final ContainerNode containerNode = ImmutableContainerNodeBuilder.create()
140 .withNodeIdentifier(new NodeIdentifier(ID_INTS))
141 .withChild(ImmutableNodes.mapNodeBuilder(ID_INT).build())
144 DOMDataWriteTransaction tx = domDataBroker.newWriteOnlyTransaction();
145 // write only the top list
146 tx.merge(LogicalDatastoreType.CONFIGURATION, ID_INTS_YID, containerNode);
148 tx.submit().checkedGet(INIT_TX_TIMEOUT_SECONDS, TimeUnit.SECONDS);
149 } catch (final OptimisticLockFailedException e) {
150 // when multiple write-transactions are executed concurrently we need to ignore this.
151 // If we get optimistic lock here it means id-ints already exists and we can continue.
152 LOG.debug("Got an optimistic lock when writing initial top level list element.", e);
153 } catch (final TransactionCommitFailedException | TimeoutException e) {
154 LOG.error("Error writing top-level path {}: {}", ID_INTS_YID, containerNode, e);
155 return RpcResultBuilder.<WriteTransactionsOutput>failed().withError(RpcError.ErrorType.APPLICATION,
156 String.format("Could not start write transactions - error writing top-level path %s: %s",
157 ID_INTS_YID, containerNode), e).buildFuture();
160 tx = domDataBroker.newWriteOnlyTransaction();
161 tx.merge(LogicalDatastoreType.CONFIGURATION, idListItem, entry);
164 tx.submit().get(INIT_TX_TIMEOUT_SECONDS, TimeUnit.SECONDS);
165 } catch (InterruptedException | ExecutionException | TimeoutException e) {
166 LOG.error("Error writing top-level path {}: {}", idListItem, entry, e);
167 return RpcResultBuilder.<WriteTransactionsOutput>failed().withError(RpcError.ErrorType.APPLICATION,
168 String.format("Could not start write transactions - error writing list entry path %s: %s",
169 idListItem, entry), e).buildFuture();
172 LOG.debug("Filling the item list with initial values.");
174 final CollectionNodeBuilder<MapEntryNode, MapNode> mapBuilder = ImmutableNodes.mapNodeBuilder(ITEM);
176 final YangInstanceIdentifier itemListId = idListItem.node(ITEM);
177 tx = domDataBroker.newWriteOnlyTransaction();
178 final MapNode itemListNode = mapBuilder.build();
179 tx.put(LogicalDatastoreType.CONFIGURATION, itemListId, itemListNode);
182 tx.submit().get(INIT_TX_TIMEOUT_SECONDS, TimeUnit.SECONDS);
183 } catch (InterruptedException | ExecutionException | TimeoutException e) {
184 LOG.error("Error filling initial item list path {}: {}", itemListId, itemListNode, e);
185 return RpcResultBuilder.<WriteTransactionsOutput>failed().withError(RpcError.ErrorType.APPLICATION,
186 String.format("Could not start write transactions - error filling initial item list path %s: %s",
187 itemListId, itemListNode), e).buildFuture();
190 final WriteTransactionsHandler handler;
191 if (input.isChainedTransactions()) {
192 handler = new Chained(domDataBroker, idListItem, input);
194 handler = new Simple(domDataBroker, idListItem, input);
199 LOG.info("Write transactions successfully started");
200 return handler.completionFuture;
204 ListenableFuture<Void> execWrite(final long txId) {
205 final int i = nextInt(MAX_ITEM + 1);
207 final YangInstanceIdentifier entryId =
208 idListItem.node(ITEM).node(YangInstanceIdentifier.NodeIdentifierWithPredicates.of(ITEM, NUMBER, i));
210 final DOMDataWriteTransaction tx = createTransaction();
212 if (usedValues.contains(i)) {
213 LOG.debug("Deleting item: {}", i);
214 deleteTx.incrementAndGet();
215 tx.delete(LogicalDatastoreType.CONFIGURATION, entryId);
216 usedValues.remove(i);
219 LOG.debug("Inserting item: {}", i);
220 insertTx.incrementAndGet();
221 final MapEntryNode entry = ImmutableNodes.mapEntry(ITEM, NUMBER, i);
222 tx.put(LogicalDatastoreType.CONFIGURATION, entryId, entry);
230 void runFailed(final Throwable cause, final long txId) {
231 completionFuture.set(RpcResultBuilder.<WriteTransactionsOutput>failed()
232 .withError(RpcError.ErrorType.APPLICATION, "Commit failed for tx # " + txId, cause).build());
236 void runSuccessful(final long allTx) {
237 final WriteTransactionsOutput output = new WriteTransactionsOutputBuilder()
239 .setInsertTx(insertTx.get())
240 .setDeleteTx(deleteTx.get())
243 completionFuture.set(RpcResultBuilder.<WriteTransactionsOutput>success()
244 .withResult(output).build());
248 void runTimedOut(final String cause) {
249 completionFuture.set(RpcResultBuilder.<WriteTransactionsOutput>failed()
250 .withError(RpcError.ErrorType.APPLICATION, cause).build());
253 abstract DOMDataWriteTransaction createTransaction();
255 abstract int nextInt(int bound);