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
   9 package org.opendaylight.controller.clustering.it.provider.impl;
  10
  11 import com.google.common.util.concurrent.CheckedFuture;
  12 import com.google.common.util.concurrent.Futures;
  13 import com.google.common.util.concurrent.ListenableFuture;
  14 import com.google.common.util.concurrent.SettableFuture;
  15 import java.util.ArrayList;
  16 import java.util.HashSet;
  17 import java.util.LinkedHashSet;
  18 import java.util.List;
  19 import java.util.Set;
  20 import java.util.SplittableRandom;
  21 import java.util.concurrent.ExecutionException;
  22 import java.util.concurrent.Executors;
  23 import java.util.concurrent.ScheduledExecutorService;
  24 import java.util.concurrent.ScheduledFuture;
  25 import java.util.concurrent.TimeUnit;
  26 import java.util.concurrent.TimeoutException;
  27 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
  28 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  29 import org.opendaylight.controller.md.sal.common.api.data.OptimisticLockFailedException;
  30 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
  31 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
  32 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  33 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  34 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  35 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
  36 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.WriteTransactionsInput;
  37 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.WriteTransactionsOutput;
  38 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.WriteTransactionsOutputBuilder;
  39 import org.opendaylight.yangtools.yang.common.QName;
  40 import org.opendaylight.yangtools.yang.common.RpcError;
  41 import org.opendaylight.yangtools.yang.common.RpcResult;
  42 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  43 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  44 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  45 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  46 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  47 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  48 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  49 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
  50 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
  51 import org.slf4j.Logger;
  52 import org.slf4j.LoggerFactory;
  53
  54 public class WriteTransactionsHandler implements Runnable {
  55
  56     private static final Logger LOG = LoggerFactory.getLogger(WriteTransactionsHandler.class);
  57     private static final int SECOND_AS_NANO = 1000000000;
  58     //2^20 as in the model
  59     private static final int MAX_ITEM = 1048576;
  60
  61     private static final QName ID_INTS =
  62             QName.create("tag:opendaylight.org,2017:controller:yang:lowlevel:target", "2017-02-15", "id-ints");
  63     private static final QName ID_INT =
  64             QName.create("tag:opendaylight.org,2017:controller:yang:lowlevel:target", "2017-02-15", "id-int");
  65     private static final QName ID =
  66             QName.create("tag:opendaylight.org,2017:controller:yang:lowlevel:target", "2017-02-15", "id");
  67     private static final QName ITEM =
  68             QName.create("tag:opendaylight.org,2017:controller:yang:lowlevel:target", "2017-02-15", "item");
  69     private static final QName NUMBER =
  70             QName.create("tag:opendaylight.org,2017:controller:yang:lowlevel:target", "2017-02-15", "number");
  71
  72     public static final YangInstanceIdentifier ID_INTS_YID = YangInstanceIdentifier.of(ID_INTS);
  73     public static final YangInstanceIdentifier ID_INT_YID = ID_INTS_YID.node(ID_INT);
  74
  75     private final DOMDataBroker domDataBroker;
  76     private final Long timeToTake;
  77     private final Long delay;
  78     private final String id;
  79     private final WriteTransactionsInput input;
  80
  81     private final ScheduledExecutorService executor = Executors.newSingleThreadScheduledExecutor();
  82     private final ArrayList<CheckedFuture<Void, TransactionCommitFailedException>> futures = new ArrayList<>();
  83     private final Set<Integer> usedValues = new HashSet<>();
  84
  85     private RandomnessProvider random;
  86     private TxProvider txProvider;
  87
  88     private long startTime;
  89     private SettableFuture<RpcResult<WriteTransactionsOutput>> completionFuture;
  90
  91     private long allTx = 0;
  92     private long insertTx = 0;
  93     private long deleteTx = 0;
  94     private ScheduledFuture<?> scheduledFuture;
  95     private YangInstanceIdentifier idListWithKey;
  96
  97     public WriteTransactionsHandler(final DOMDataBroker domDataBroker, final WriteTransactionsInput input) {
  98         this.domDataBroker = domDataBroker;
  99         this.input = input;
 100
 101         timeToTake = input.getSeconds() * SECOND_AS_NANO;
 102         delay = SECOND_AS_NANO / input.getTransactionsPerSecond();
 103         id = input.getId();
 104     }
 105
 106     @Override
 107     public void run() {
 108         final long current = System.nanoTime();
 109
 110         futures.add(execWrite());
 111
 112         maybeFinish(current);
 113     }
 114
 115     public void start(final SettableFuture<RpcResult<WriteTransactionsOutput>> settableFuture) {
 116         LOG.debug("Starting write-transactions.");
 117
 118         if (input.isChainedTransactions()) {
 119             txProvider = new TxChainBackedProvider(domDataBroker, settableFuture, executor);
 120             random = new BasicProvider();
 121         } else {
 122             txProvider = new DataBrokerBackedProvider(domDataBroker);
 123             random = new NonConflictingProvider();
 124         }
 125
 126         if (ensureListExists(settableFuture) && fillInitialList(settableFuture)) {
 127             startTime = System.nanoTime();
 128             completionFuture = settableFuture;
 129             scheduledFuture = executor.scheduleAtFixedRate(this, 0, delay, TimeUnit.NANOSECONDS);
 130         } else {
 131             executor.shutdown();
 132         }
 133     }
 134
 135     private boolean ensureListExists(final SettableFuture<RpcResult<WriteTransactionsOutput>> settableFuture) {
 136
 137         final ContainerNode containerNode = ImmutableContainerNodeBuilder.create()
 138                 .withNodeIdentifier(new NodeIdentifier(ID_INTS))
 139                 .withChild(ImmutableNodes.mapNodeBuilder(ID_INT).build())
 140                 .build();
 141
 142         DOMDataWriteTransaction tx = txProvider.createTransaction();
 143         // write only the top list
 144         tx.merge(LogicalDatastoreType.CONFIGURATION, ID_INTS_YID, containerNode);
 145         try {
 146             tx.submit().checkedGet();
 147         } catch (final OptimisticLockFailedException e) {
 148             // when multiple write-transactions are executed concurrently we need to ignore this.
 149             // If we get optimistic lock here it means id-ints already exists and we can continue.
 150             LOG.debug("Got an optimistic lock when writing initial top level list element.", e);
 151         } catch (final TransactionCommitFailedException e) {
 152             LOG.warn("Unable to ensure IdInts list for id: {} exists.", id, e);
 153             settableFuture.set(RpcResultBuilder.<WriteTransactionsOutput>failed()
 154                     .withError(RpcError.ErrorType.APPLICATION, "Unexpected-exception", e).build());
 155             return false;
 156         }
 157
 158         final MapEntryNode entry = ImmutableNodes.mapEntryBuilder(ID_INT, ID, id)
 159                 .withChild(ImmutableNodes.mapNodeBuilder(ITEM).build())
 160                 .build();
 161
 162         idListWithKey = ID_INT_YID.node(entry.getIdentifier());
 163         tx = txProvider.createTransaction();
 164         tx.merge(LogicalDatastoreType.CONFIGURATION, idListWithKey, entry);
 165
 166         try {
 167             tx.submit().checkedGet();
 168         } catch (final TransactionCommitFailedException e) {
 169             LOG.warn("Unable to ensure IdInts list for id: {} exists.", id, e);
 170             settableFuture.set(RpcResultBuilder.<WriteTransactionsOutput>failed()
 171                     .withError(RpcError.ErrorType.APPLICATION, "Unexpected-exception", e).build());
 172             return false;
 173         }
 174
 175         return true;
 176     }
 177
 178     private boolean fillInitialList(final SettableFuture<RpcResult<WriteTransactionsOutput>> settableFuture) {
 179         LOG.debug("Filling the item list with initial values.");
 180
 181         final CollectionNodeBuilder<MapEntryNode, MapNode> mapBuilder = ImmutableNodes.mapNodeBuilder(ITEM);
 182         for (int i = 0; i < MAX_ITEM / 2; i++) {
 183             usedValues.add(i);
 184             mapBuilder.withChild(ImmutableNodes.mapEntry(ITEM, NUMBER, i));
 185         }
 186
 187         final YangInstanceIdentifier itemListId = idListWithKey.node(ITEM);
 188         final DOMDataWriteTransaction tx = txProvider.createTransaction();
 189         tx.put(LogicalDatastoreType.CONFIGURATION, itemListId, mapBuilder.build());
 190
 191         try {
 192             tx.submit().checkedGet();
 193         } catch (final TransactionCommitFailedException e) {
 194             LOG.warn("Unable to fill the initial item list.", e);
 195             settableFuture.set(RpcResultBuilder.<WriteTransactionsOutput>failed()
 196                     .withError(RpcError.ErrorType.APPLICATION, "Unexpected-exception", e).build());
 197             return false;
 198         }
 199
 200         return true;
 201     }
 202
 203     private CheckedFuture<Void, TransactionCommitFailedException> execWrite() {
 204         final int i = random.nextInt(MAX_ITEM + 1);
 205
 206         final YangInstanceIdentifier entryId =
 207                 idListWithKey.node(ITEM).node(new YangInstanceIdentifier.NodeIdentifierWithPredicates(ITEM, NUMBER, i));
 208
 209         final DOMDataWriteTransaction tx = txProvider.createTransaction();
 210         allTx++;
 211
 212         if (usedValues.contains(i)) {
 213             LOG.debug("Deleting item: {}", i);
 214             deleteTx++;
 215             tx.delete(LogicalDatastoreType.CONFIGURATION, entryId);
 216             usedValues.remove(i);
 217
 218         } else {
 219             LOG.debug("Inserting item: {}", i);
 220             insertTx++;
 221             final MapEntryNode entry = ImmutableNodes.mapEntry(ITEM, NUMBER, i);
 222             tx.put(LogicalDatastoreType.CONFIGURATION, entryId, entry);
 223             usedValues.add(i);
 224         }
 225
 226         return tx.submit();
 227     }
 228
 229     private void maybeFinish(final long current) {
 230         if ((current - startTime) > timeToTake) {
 231             LOG.debug("Reached max running time, waiting for futures to complete.");
 232             scheduledFuture.cancel(false);
 233
 234             final ListenableFuture<List<Void>> allFutures = Futures.allAsList(futures);
 235
 236             try {
 237                 allFutures.get(30, TimeUnit.SECONDS);
 238
 239                 LOG.debug("All futures completed successfully.");
 240
 241                 final WriteTransactionsOutput output = new WriteTransactionsOutputBuilder()
 242                         .setAllTx(allTx)
 243                         .setInsertTx(insertTx)
 244                         .setDeleteTx(deleteTx)
 245                         .build();
 246
 247                 completionFuture.set(RpcResultBuilder.<WriteTransactionsOutput>success()
 248                         .withResult(output).build());
 249
 250                 executor.shutdown();
 251             } catch (InterruptedException | ExecutionException | TimeoutException exception) {
 252                 LOG.error("Write transactions failed.", exception);
 253                 completionFuture.set(RpcResultBuilder.<WriteTransactionsOutput>failed()
 254                         .withError(RpcError.ErrorType.APPLICATION, "Unexpected-exception", exception).build());
 255
 256                 executor.shutdown();
 257             }
 258         }
 259     }
 260
 261     private interface RandomnessProvider {
 262         int nextInt(int bound);
 263     }
 264
 265     private static class NonConflictingProvider implements RandomnessProvider {
 266
 267         private final SplittableRandom random = new SplittableRandom();
 268         private final LinkedHashSet<Integer> previousNumbers = new LinkedHashSet<>();
 269
 270         @Override
 271         public int nextInt(int bound) {
 272             int nextInt;
 273             do {
 274                 nextInt = random.nextInt(bound);
 275             } while (previousNumbers.contains(nextInt));
 276
 277             if (previousNumbers.size() > 100000) {
 278                 previousNumbers.iterator().remove();
 279             }
 280             previousNumbers.add(nextInt);
 281
 282             return nextInt;
 283         }
 284     }
 285
 286     private static class BasicProvider implements RandomnessProvider {
 287
 288         private final SplittableRandom random = new SplittableRandom();
 289
 290         @Override
 291         public int nextInt(int bound) {
 292             return random.nextInt(bound);
 293         }
 294     }
 295
 296     private interface TxProvider {
 297
 298         DOMDataWriteTransaction createTransaction();
 299     }
 300
 301     private static class TxChainBackedProvider implements TxProvider {
 302
 303         private final DOMTransactionChain transactionChain;
 304
 305         TxChainBackedProvider(final DOMDataBroker dataBroker,
 306                               final SettableFuture<RpcResult<WriteTransactionsOutput>> completionFuture,
 307                               final ScheduledExecutorService executor) {
 308
 309             transactionChain =
 310                     dataBroker.createTransactionChain(new TestChainListener(completionFuture, executor));
 311         }
 312
 313         @Override
 314         public DOMDataWriteTransaction createTransaction() {
 315             return transactionChain.newWriteOnlyTransaction();
 316         }
 317     }
 318
 319     private static class DataBrokerBackedProvider implements TxProvider {
 320
 321         private final DOMDataBroker dataBroker;
 322
 323         DataBrokerBackedProvider(final DOMDataBroker dataBroker) {
 324             this.dataBroker = dataBroker;
 325         }
 326
 327         @Override
 328         public DOMDataWriteTransaction createTransaction() {
 329             return dataBroker.newWriteOnlyTransaction();
 330         }
 331     }
 332
 333     private static class TestChainListener implements TransactionChainListener {
 334
 335         private final SettableFuture<RpcResult<WriteTransactionsOutput>> resultFuture;
 336         private final ScheduledExecutorService executor;
 337
 338         TestChainListener(final SettableFuture<RpcResult<WriteTransactionsOutput>> resultFuture,
 339                           final ScheduledExecutorService executor) {
 340
 341             this.resultFuture = resultFuture;
 342             this.executor = executor;
 343         }
 344
 345         @Override
 346         public void onTransactionChainFailed(final TransactionChain<?, ?> chain,
 347                                              final AsyncTransaction<?, ?> transaction,
 348                                              final Throwable cause) {
 349             LOG.warn("Transaction chain failed.", cause);
 350             resultFuture.set(RpcResultBuilder.<WriteTransactionsOutput>failed()
 351                     .withError(RpcError.ErrorType.APPLICATION, "Unexpected-exception", cause).build());
 352
 353             executor.shutdown();
 354         }
 355
 356         @Override
 357         public void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
 358             LOG.debug("Transaction chain closed successfully.");
 359         }
 360     }
 361 }