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.FluentFuture;
13 import com.google.common.util.concurrent.ListenableFuture;
14 import com.google.common.util.concurrent.SettableFuture;
15 import java.util.LinkedHashSet;
17 import java.util.SplittableRandom;
18 import java.util.concurrent.ConcurrentHashMap;
19 import java.util.concurrent.ExecutionException;
20 import java.util.concurrent.TimeUnit;
21 import java.util.concurrent.TimeoutException;
22 import java.util.concurrent.atomic.AtomicLong;
23 import org.eclipse.jdt.annotation.NonNull;
24 import org.opendaylight.mdsal.common.api.CommitInfo;
25 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
26 import org.opendaylight.mdsal.common.api.OptimisticLockFailedException;
27 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
28 import org.opendaylight.mdsal.dom.api.DOMDataTreeTransaction;
29 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
30 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
31 import org.opendaylight.mdsal.dom.api.DOMTransactionChainListener;
32 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.WriteTransactionsInput;
33 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.WriteTransactionsOutput;
34 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.WriteTransactionsOutputBuilder;
35 import org.opendaylight.yangtools.yang.common.RpcError;
36 import org.opendaylight.yangtools.yang.common.RpcResult;
37 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
38 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
39 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
40 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
41 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
42 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
43 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
44 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
45 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
46 import org.slf4j.Logger;
47 import org.slf4j.LoggerFactory;
49 public abstract class WriteTransactionsHandler extends AbstractTransactionHandler {
50 private static final class Chained extends WriteTransactionsHandler implements DOMTransactionChainListener {
51 private final SplittableRandom random = new SplittableRandom();
52 private final DOMTransactionChain transactionChain;
54 Chained(final DOMDataBroker dataBroker, final YangInstanceIdentifier idListItem,
55 final WriteTransactionsInput input) {
56 super(idListItem, input);
57 transactionChain = dataBroker.createTransactionChain(this);
61 DOMDataTreeWriteTransaction createTransaction() {
62 return transactionChain.newWriteOnlyTransaction();
66 int nextInt(final int bound) {
67 return random.nextInt(bound);
71 public void onTransactionChainFailed(final DOMTransactionChain chain, final DOMDataTreeTransaction transaction,
72 final Throwable cause) {
73 // This is expected to happen frequently in isolation testing.
74 LOG.debug("Transaction chain failed.", cause);
75 // Do not return RPC here, rely on transaction failure to call runFailed.
79 public void onTransactionChainSuccessful(final DOMTransactionChain chain) {
80 LOG.debug("Transaction chain closed successfully.");
84 private static final class Simple extends WriteTransactionsHandler {
85 private final LinkedHashSet<Integer> previousNumbers = new LinkedHashSet<>();
86 private final SplittableRandom random = new SplittableRandom();
87 private final DOMDataBroker dataBroker;
89 Simple(final DOMDataBroker dataBroker, final YangInstanceIdentifier idListItem,
90 final WriteTransactionsInput input) {
91 super(idListItem, input);
92 this.dataBroker = requireNonNull(dataBroker);
96 DOMDataTreeWriteTransaction createTransaction() {
97 return dataBroker.newWriteOnlyTransaction();
101 int nextInt(final int bound) {
104 nextInt = random.nextInt(bound);
105 } while (previousNumbers.contains(nextInt));
107 if (previousNumbers.size() > 100000) {
108 previousNumbers.iterator().remove();
110 previousNumbers.add(nextInt);
116 private static final Logger LOG = LoggerFactory.getLogger(WriteTransactionsHandler.class);
118 final SettableFuture<RpcResult<WriteTransactionsOutput>> completionFuture = SettableFuture.create();
119 private final Set<Integer> usedValues = ConcurrentHashMap.newKeySet();
120 private final YangInstanceIdentifier idListItem;
122 private final AtomicLong insertTx = new AtomicLong();
123 private final AtomicLong deleteTx = new AtomicLong();
125 WriteTransactionsHandler(final YangInstanceIdentifier idListItem, final WriteTransactionsInput input) {
127 this.idListItem = requireNonNull(idListItem);
130 public static ListenableFuture<RpcResult<WriteTransactionsOutput>> start(final DOMDataBroker domDataBroker,
131 final WriteTransactionsInput input) {
132 LOG.info("Starting write transactions with input {}", input);
134 final String id = input.getId();
135 final MapEntryNode entry = ImmutableNodes.mapEntryBuilder(ID_INT, ID, id)
136 .withChild(ImmutableNodes.mapNodeBuilder(ITEM).build())
138 final YangInstanceIdentifier idListItem = ID_INT_YID.node(entry.getIdentifier());
140 final ContainerNode containerNode = ImmutableContainerNodeBuilder.create()
141 .withNodeIdentifier(new NodeIdentifier(ID_INTS))
142 .withChild(ImmutableNodes.mapNodeBuilder(ID_INT).build())
145 DOMDataTreeWriteTransaction tx = domDataBroker.newWriteOnlyTransaction();
146 // write only the top list
147 tx.merge(LogicalDatastoreType.CONFIGURATION, ID_INTS_YID, containerNode);
149 tx.commit().get(INIT_TX_TIMEOUT_SECONDS, TimeUnit.SECONDS);
150 } catch (InterruptedException | TimeoutException e) {
151 LOG.error("Error writing top-level path {}: {}", ID_INTS_YID, containerNode, e);
152 return RpcResultBuilder.<WriteTransactionsOutput>failed().withError(RpcError.ErrorType.APPLICATION,
153 String.format("Could not start write transactions - error writing top-level path %s: %s",
154 ID_INTS_YID, containerNode), e).buildFuture();
155 } catch (ExecutionException e) {
156 final Throwable cause = e.getCause();
157 if (cause instanceof OptimisticLockFailedException) {
158 // when multiple write-transactions are executed concurrently we need to ignore this.
159 // If we get optimistic lock here it means id-ints already exists and we can continue.
160 LOG.debug("Got an optimistic lock when writing initial top level list element.", e);
162 LOG.error("Error writing top-level path {}: {}", ID_INTS_YID, containerNode, e);
163 return RpcResultBuilder.<WriteTransactionsOutput>failed().withError(RpcError.ErrorType.APPLICATION,
164 String.format("Could not start write transactions - error writing top-level path %s: %s",
165 ID_INTS_YID, containerNode), e).buildFuture();
169 tx = domDataBroker.newWriteOnlyTransaction();
170 tx.merge(LogicalDatastoreType.CONFIGURATION, idListItem, entry);
173 tx.commit().get(INIT_TX_TIMEOUT_SECONDS, TimeUnit.SECONDS);
174 } catch (InterruptedException | ExecutionException | TimeoutException e) {
175 LOG.error("Error writing top-level path {}: {}", idListItem, entry, e);
176 return RpcResultBuilder.<WriteTransactionsOutput>failed().withError(RpcError.ErrorType.APPLICATION,
177 String.format("Could not start write transactions - error writing list entry path %s: %s",
178 idListItem, entry), e).buildFuture();
181 LOG.debug("Filling the item list with initial values.");
183 final CollectionNodeBuilder<MapEntryNode, MapNode> mapBuilder = ImmutableNodes.mapNodeBuilder(ITEM);
185 final YangInstanceIdentifier itemListId = idListItem.node(ITEM);
186 tx = domDataBroker.newWriteOnlyTransaction();
187 final MapNode itemListNode = mapBuilder.build();
188 tx.put(LogicalDatastoreType.CONFIGURATION, itemListId, itemListNode);
191 tx.commit().get(INIT_TX_TIMEOUT_SECONDS, TimeUnit.SECONDS);
192 } catch (InterruptedException | ExecutionException | TimeoutException e) {
193 LOG.error("Error filling initial item list path {}: {}", itemListId, itemListNode, e);
194 return RpcResultBuilder.<WriteTransactionsOutput>failed().withError(RpcError.ErrorType.APPLICATION,
195 String.format("Could not start write transactions - error filling initial item list path %s: %s",
196 itemListId, itemListNode), e).buildFuture();
199 final WriteTransactionsHandler handler;
200 if (input.getChainedTransactions()) {
201 handler = new Chained(domDataBroker, idListItem, input);
203 handler = new Simple(domDataBroker, idListItem, input);
208 LOG.info("Write transactions successfully started");
209 return handler.completionFuture;
213 FluentFuture<? extends @NonNull CommitInfo> execWrite(final long txId) {
214 final int i = nextInt(MAX_ITEM + 1);
216 final YangInstanceIdentifier entryId =
217 idListItem.node(ITEM).node(YangInstanceIdentifier.NodeIdentifierWithPredicates.of(ITEM, NUMBER, i));
219 final DOMDataTreeWriteTransaction tx = createTransaction();
221 if (usedValues.contains(i)) {
222 LOG.debug("Deleting item: {}", i);
223 deleteTx.incrementAndGet();
224 tx.delete(LogicalDatastoreType.CONFIGURATION, entryId);
225 usedValues.remove(i);
228 LOG.debug("Inserting item: {}", i);
229 insertTx.incrementAndGet();
230 final MapEntryNode entry = ImmutableNodes.mapEntry(ITEM, NUMBER, i);
231 tx.put(LogicalDatastoreType.CONFIGURATION, entryId, entry);
239 void runFailed(final Throwable cause, final long txId) {
240 completionFuture.set(RpcResultBuilder.<WriteTransactionsOutput>failed()
241 .withError(RpcError.ErrorType.APPLICATION, "Commit failed for tx # " + txId, cause).build());
245 void runSuccessful(final long allTx) {
246 final WriteTransactionsOutput output = new WriteTransactionsOutputBuilder()
248 .setInsertTx(insertTx.get())
249 .setDeleteTx(deleteTx.get())
252 completionFuture.set(RpcResultBuilder.<WriteTransactionsOutput>success()
253 .withResult(output).build());
257 void runTimedOut(final String cause) {
258 completionFuture.set(RpcResultBuilder.<WriteTransactionsOutput>failed()
259 .withError(RpcError.ErrorType.APPLICATION, cause).build());
262 abstract DOMDataTreeWriteTransaction createTransaction();
264 abstract int nextInt(int bound);