opendaylight/md-sal/samples/clustering-test-app/provider/src/main/java/org/opendaylight/controller/clustering/it/provider/impl/WriteTransactionsHandler.java

   1 /*
   2  * Copyright (c) 2017 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.controller.clustering.it.provider.impl;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  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;
  16 import java.util.Set;
  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.ErrorType;
  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.api.schema.SystemMapNode;
  44 import org.opendaylight.yangtools.yang.data.api.schema.builder.CollectionNodeBuilder;
  45 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  46 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
  47 import org.slf4j.Logger;
  48 import org.slf4j.LoggerFactory;
  49
  50 public abstract class WriteTransactionsHandler extends AbstractTransactionHandler {
  51     private static final class Chained extends WriteTransactionsHandler implements DOMTransactionChainListener {
  52         private final SplittableRandom random = new SplittableRandom();
  53         private final DOMTransactionChain transactionChain;
  54
  55         Chained(final DOMDataBroker dataBroker, final YangInstanceIdentifier idListItem,
  56             final WriteTransactionsInput input) {
  57             super(idListItem, input);
  58             transactionChain = dataBroker.createTransactionChain(this);
  59         }
  60
  61         @Override
  62         DOMDataTreeWriteTransaction createTransaction() {
  63             return transactionChain.newWriteOnlyTransaction();
  64         }
  65
  66         @Override
  67         int nextInt(final int bound) {
  68             return random.nextInt(bound);
  69         }
  70
  71         @Override
  72         public void onTransactionChainFailed(final DOMTransactionChain chain, final DOMDataTreeTransaction transaction,
  73                 final Throwable cause) {
  74             // This is expected to happen frequently in isolation testing.
  75             LOG.debug("Transaction chain failed.", cause);
  76             // Do not return RPC here, rely on transaction failure to call runFailed.
  77         }
  78
  79         @Override
  80         public void onTransactionChainSuccessful(final DOMTransactionChain chain) {
  81             LOG.debug("Transaction chain closed successfully.");
  82         }
  83     }
  84
  85     private static final class Simple extends WriteTransactionsHandler {
  86         private final LinkedHashSet<Integer> previousNumbers = new LinkedHashSet<>();
  87         private final SplittableRandom random = new SplittableRandom();
  88         private final DOMDataBroker dataBroker;
  89
  90         Simple(final DOMDataBroker dataBroker, final YangInstanceIdentifier idListItem,
  91             final WriteTransactionsInput input) {
  92             super(idListItem, input);
  93             this.dataBroker = requireNonNull(dataBroker);
  94         }
  95
  96         @Override
  97         DOMDataTreeWriteTransaction createTransaction() {
  98             return dataBroker.newWriteOnlyTransaction();
  99         }
 100
 101         @Override
 102         int nextInt(final int bound) {
 103             int nextInt;
 104             do {
 105                 nextInt = random.nextInt(bound);
 106             } while (previousNumbers.contains(nextInt));
 107
 108             if (previousNumbers.size() > 100000) {
 109                 previousNumbers.iterator().remove();
 110             }
 111             previousNumbers.add(nextInt);
 112
 113             return nextInt;
 114         }
 115     }
 116
 117     private static final Logger LOG = LoggerFactory.getLogger(WriteTransactionsHandler.class);
 118
 119     final SettableFuture<RpcResult<WriteTransactionsOutput>> completionFuture = SettableFuture.create();
 120     private final Set<Integer> usedValues = ConcurrentHashMap.newKeySet();
 121     private final YangInstanceIdentifier idListItem;
 122
 123     private final AtomicLong insertTx = new AtomicLong();
 124     private final AtomicLong deleteTx = new AtomicLong();
 125
 126     WriteTransactionsHandler(final YangInstanceIdentifier idListItem, final WriteTransactionsInput input) {
 127         super(input);
 128         this.idListItem = requireNonNull(idListItem);
 129     }
 130
 131     public static ListenableFuture<RpcResult<WriteTransactionsOutput>> start(final DOMDataBroker domDataBroker,
 132             final WriteTransactionsInput input) {
 133         LOG.info("Starting write transactions with input {}", input);
 134
 135         final String id = input.getId();
 136         final MapEntryNode entry = ImmutableNodes.mapEntryBuilder(ID_INT, ID, id)
 137                 .withChild(ImmutableNodes.mapNodeBuilder(ITEM).build())
 138                 .build();
 139         final YangInstanceIdentifier idListItem = ID_INT_YID.node(entry.getIdentifier());
 140
 141         final ContainerNode containerNode = ImmutableContainerNodeBuilder.create()
 142                 .withNodeIdentifier(new NodeIdentifier(ID_INTS))
 143                 .withChild(ImmutableNodes.mapNodeBuilder(ID_INT).build())
 144                 .build();
 145
 146         DOMDataTreeWriteTransaction tx = domDataBroker.newWriteOnlyTransaction();
 147         // write only the top list
 148         tx.merge(LogicalDatastoreType.CONFIGURATION, ID_INTS_YID, containerNode);
 149         try {
 150             tx.commit().get(INIT_TX_TIMEOUT_SECONDS, TimeUnit.SECONDS);
 151         } catch (InterruptedException | TimeoutException e) {
 152             LOG.error("Error writing top-level path {}: {}", ID_INTS_YID, containerNode, e);
 153             return RpcResultBuilder.<WriteTransactionsOutput>failed().withError(ErrorType.APPLICATION,
 154                 String.format("Could not start write transactions - error writing top-level path %s:  %s",
 155                     ID_INTS_YID, containerNode), e).buildFuture();
 156         } catch (ExecutionException e) {
 157             final Throwable cause = e.getCause();
 158             if (cause instanceof OptimisticLockFailedException) {
 159                 // when multiple write-transactions are executed concurrently we need to ignore this.
 160                 // If we get optimistic lock here it means id-ints already exists and we can continue.
 161                 LOG.debug("Got an optimistic lock when writing initial top level list element.", e);
 162             } else {
 163                 LOG.error("Error writing top-level path {}: {}", ID_INTS_YID, containerNode, e);
 164                 return RpcResultBuilder.<WriteTransactionsOutput>failed().withError(ErrorType.APPLICATION,
 165                     String.format("Could not start write transactions - error writing top-level path %s:  %s",
 166                         ID_INTS_YID, containerNode), e).buildFuture();
 167             }
 168         }
 169
 170         tx = domDataBroker.newWriteOnlyTransaction();
 171         tx.merge(LogicalDatastoreType.CONFIGURATION, idListItem, entry);
 172
 173         try {
 174             tx.commit().get(INIT_TX_TIMEOUT_SECONDS, TimeUnit.SECONDS);
 175         } catch (InterruptedException | ExecutionException | TimeoutException e) {
 176             LOG.error("Error writing top-level path {}: {}", idListItem, entry, e);
 177             return RpcResultBuilder.<WriteTransactionsOutput>failed().withError(ErrorType.APPLICATION,
 178                 String.format("Could not start write transactions - error writing list entry path %s: %s",
 179                     idListItem, entry), e).buildFuture();
 180         }
 181
 182         LOG.debug("Filling the item list with initial values.");
 183
 184         final CollectionNodeBuilder<MapEntryNode, SystemMapNode> mapBuilder = ImmutableNodes.mapNodeBuilder(ITEM);
 185
 186         final YangInstanceIdentifier itemListId = idListItem.node(ITEM);
 187         tx = domDataBroker.newWriteOnlyTransaction();
 188         final MapNode itemListNode = mapBuilder.build();
 189         tx.put(LogicalDatastoreType.CONFIGURATION, itemListId, itemListNode);
 190
 191         try {
 192             tx.commit().get(INIT_TX_TIMEOUT_SECONDS, TimeUnit.SECONDS);
 193         } catch (InterruptedException | ExecutionException | TimeoutException e) {
 194             LOG.error("Error filling initial item list path {}: {}", itemListId, itemListNode, e);
 195             return RpcResultBuilder.<WriteTransactionsOutput>failed().withError(ErrorType.APPLICATION,
 196                 String.format("Could not start write transactions - error filling initial item list path %s: %s",
 197                     itemListId, itemListNode), e).buildFuture();
 198         }
 199
 200         final WriteTransactionsHandler handler;
 201         if (input.getChainedTransactions()) {
 202             handler = new Chained(domDataBroker, idListItem, input);
 203         } else {
 204             handler = new Simple(domDataBroker, idListItem, input);
 205         }
 206
 207         handler.doStart();
 208
 209         LOG.info("Write transactions successfully started");
 210         return handler.completionFuture;
 211     }
 212
 213     @Override
 214     FluentFuture<? extends @NonNull CommitInfo> execWrite(final long txId) {
 215         final int i = nextInt(MAX_ITEM + 1);
 216
 217         final YangInstanceIdentifier entryId =
 218                 idListItem.node(ITEM).node(YangInstanceIdentifier.NodeIdentifierWithPredicates.of(ITEM, NUMBER, i));
 219
 220         final DOMDataTreeWriteTransaction tx = createTransaction();
 221
 222         if (usedValues.contains(i)) {
 223             LOG.debug("Deleting item: {}", i);
 224             deleteTx.incrementAndGet();
 225             tx.delete(LogicalDatastoreType.CONFIGURATION, entryId);
 226             usedValues.remove(i);
 227
 228         } else {
 229             LOG.debug("Inserting item: {}", i);
 230             insertTx.incrementAndGet();
 231             final MapEntryNode entry = ImmutableNodes.mapEntry(ITEM, NUMBER, i);
 232             tx.put(LogicalDatastoreType.CONFIGURATION, entryId, entry);
 233             usedValues.add(i);
 234         }
 235
 236         return tx.commit();
 237     }
 238
 239     @Override
 240     void runFailed(final Throwable cause, final long txId) {
 241         completionFuture.set(RpcResultBuilder.<WriteTransactionsOutput>failed()
 242             .withError(ErrorType.APPLICATION, "Commit failed for tx # " + txId, cause).build());
 243     }
 244
 245     @Override
 246     void runSuccessful(final long allTx) {
 247         final WriteTransactionsOutput output = new WriteTransactionsOutputBuilder()
 248                 .setAllTx(allTx)
 249                 .setInsertTx(insertTx.get())
 250                 .setDeleteTx(deleteTx.get())
 251                 .build();
 252
 253         completionFuture.set(RpcResultBuilder.<WriteTransactionsOutput>success()
 254                 .withResult(output).build());
 255     }
 256
 257     @Override
 258     void runTimedOut(final String cause) {
 259         completionFuture.set(RpcResultBuilder.<WriteTransactionsOutput>failed()
 260             .withError(ErrorType.APPLICATION, cause).build());
 261     }
 262
 263     abstract DOMDataTreeWriteTransaction createTransaction();
 264
 265     abstract int nextInt(int bound);
 266 }