benchmarks/src/main/java/org/opendaylight/yangtools/yang/data/impl/tree/InMemoryDataTreeBenchmark.java

   1 /*
   2  * Copyright (c) 2013 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.yangtools.yang.data.impl.tree;
   9
  10 import com.google.common.collect.Streams;
  11 import java.util.Arrays;
  12 import java.util.concurrent.TimeUnit;
  13 import java.util.stream.Collectors;
  14 import java.util.stream.IntStream;
  15 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  16 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  17 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  18 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  19 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  20 import org.opendaylight.yangtools.yang.data.api.schema.tree.CursorAwareDataTreeModification;
  21 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
  22 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeConfiguration;
  23 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
  24 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModificationCursor;
  25 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
  26 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  27 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
  28 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
  29 import org.opendaylight.yangtools.yang.data.impl.schema.tree.InMemoryDataTreeFactory;
  30 import org.openjdk.jmh.annotations.Benchmark;
  31 import org.openjdk.jmh.annotations.BenchmarkMode;
  32 import org.openjdk.jmh.annotations.Fork;
  33 import org.openjdk.jmh.annotations.Level;
  34 import org.openjdk.jmh.annotations.Measurement;
  35 import org.openjdk.jmh.annotations.Mode;
  36 import org.openjdk.jmh.annotations.OutputTimeUnit;
  37 import org.openjdk.jmh.annotations.Scope;
  38 import org.openjdk.jmh.annotations.Setup;
  39 import org.openjdk.jmh.annotations.State;
  40 import org.openjdk.jmh.annotations.TearDown;
  41 import org.openjdk.jmh.annotations.Warmup;
  42 import org.openjdk.jmh.runner.Runner;
  43 import org.openjdk.jmh.runner.RunnerException;
  44 import org.openjdk.jmh.runner.options.Options;
  45 import org.openjdk.jmh.runner.options.OptionsBuilder;
  46
  47 /**
  48  * Benchmarking of InMemoryDataTree performance. JMH is used for microbenchmarking.
  49  *
  50  * @author Lukas Sedlak &lt;lsedlak@cisco.com&gt;
  51  * @see <a href="http://openjdk.java.net/projects/code-tools/jmh/">JMH</a>
  52  */
  53 @State(Scope.Thread)
  54 @BenchmarkMode(Mode.AverageTime)
  55 @OutputTimeUnit(TimeUnit.MILLISECONDS)
  56 @Fork(1)
  57 public class InMemoryDataTreeBenchmark {
  58
  59     private static final int WARMUP_ITERATIONS = 10;
  60     private static final int MEASUREMENT_ITERATIONS = 10;
  61
  62     private static final int OUTER_LIST_100K = 100000;
  63     private static final int OUTER_LIST_50K = 50000;
  64     private static final int OUTER_LIST_10K = 10000;
  65
  66     private static final NodeIdentifierWithPredicates[] OUTER_LIST_IDS = Streams.mapWithIndex(
  67         IntStream.range(0, OUTER_LIST_100K),
  68         (i, index) -> NodeIdentifierWithPredicates.of(BenchmarkModel.OUTER_LIST_QNAME, BenchmarkModel.ID_QNAME, i))
  69             .collect(Collectors.toList()).toArray(new NodeIdentifierWithPredicates[0]);
  70
  71     private static final YangInstanceIdentifier[] OUTER_LIST_PATHS = Arrays.stream(OUTER_LIST_IDS)
  72             .map(id -> BenchmarkModel.OUTER_LIST_PATH.node(id).toOptimized())
  73             .collect(Collectors.toList()).toArray(new YangInstanceIdentifier[0]);
  74
  75     private static final MapNode EMPTY_OUTER_LIST = ImmutableNodes.mapNodeBuilder(BenchmarkModel.OUTER_LIST).build();
  76     private static final MapNode ONE_ITEM_INNER_LIST = initInnerListItems(1);
  77     private static final MapNode TWO_ITEM_INNER_LIST = initInnerListItems(2);
  78     private static final MapNode TEN_ITEM_INNER_LIST = initInnerListItems(10);
  79
  80     private static MapNode initInnerListItems(final int count) {
  81         final CollectionNodeBuilder<MapEntryNode, MapNode> mapEntryBuilder = ImmutableNodes
  82             .mapNodeBuilder(BenchmarkModel.INNER_LIST);
  83
  84         for (int i = 0; i < count; ++i) {
  85             mapEntryBuilder
  86                 .withChild(ImmutableNodes.mapEntry(BenchmarkModel.INNER_LIST_QNAME, BenchmarkModel.NAME_QNAME, i));
  87         }
  88
  89         return mapEntryBuilder.build();
  90     }
  91
  92     private static final NormalizedNode<?, ?>[] OUTER_LIST_ONE_ITEM_INNER_LIST = initOuterListItems(OUTER_LIST_100K,
  93         ONE_ITEM_INNER_LIST);
  94     private static final NormalizedNode<?, ?>[] OUTER_LIST_TWO_ITEM_INNER_LIST = initOuterListItems(OUTER_LIST_50K,
  95         TWO_ITEM_INNER_LIST);
  96     private static final NormalizedNode<?, ?>[] OUTER_LIST_TEN_ITEM_INNER_LIST = initOuterListItems(OUTER_LIST_10K,
  97         TEN_ITEM_INNER_LIST);
  98
  99     private static NormalizedNode<?,?>[] initOuterListItems(final int outerListItemsCount, final MapNode innerList) {
 100         return Arrays.stream(OUTER_LIST_IDS).limit(outerListItemsCount)
 101                 .map(id -> ImmutableNodes.mapEntryBuilder().withNodeIdentifier(id).withChild(innerList).build())
 102                 .collect(Collectors.toList()).toArray(new NormalizedNode[0]);
 103     }
 104
 105     private DataTree datastore;
 106
 107     public static void main(final String... args) throws RunnerException {
 108         Options opt = new OptionsBuilder()
 109             .include(".*" + InMemoryDataTreeBenchmark.class.getSimpleName() + ".*")
 110             .forks(1)
 111             .build();
 112
 113         new Runner(opt).run();
 114     }
 115
 116     @Setup(Level.Trial)
 117     public void setup() throws DataValidationFailedException {
 118         datastore = new InMemoryDataTreeFactory().create(DataTreeConfiguration.DEFAULT_CONFIGURATION,
 119             BenchmarkModel.createTestContext());
 120
 121         final DataTreeModification modification = begin();
 122         modification.write(BenchmarkModel.TEST_PATH, ImmutableContainerNodeBuilder.create()
 123             .withNodeIdentifier(BenchmarkModel.TEST).withChild(EMPTY_OUTER_LIST).build());
 124         commit(modification);
 125     }
 126
 127     @TearDown
 128     public void tearDown() {
 129         datastore = null;
 130     }
 131
 132     @Benchmark
 133     @Warmup(iterations = WARMUP_ITERATIONS, timeUnit = TimeUnit.MILLISECONDS)
 134     @Measurement(iterations = MEASUREMENT_ITERATIONS, timeUnit = TimeUnit.MILLISECONDS)
 135     public void write100KSingleNodeWithOneInnerItemInOneCommitBenchmark() throws DataValidationFailedException {
 136         final DataTreeModification modification = begin();
 137         for (int outerListKey = 0; outerListKey < OUTER_LIST_100K; ++outerListKey) {
 138             modification.write(OUTER_LIST_PATHS[outerListKey], OUTER_LIST_ONE_ITEM_INNER_LIST[outerListKey]);
 139         }
 140         commit(modification);
 141     }
 142
 143     @Benchmark
 144     @Warmup(iterations = WARMUP_ITERATIONS, timeUnit = TimeUnit.MILLISECONDS)
 145     @Measurement(iterations = MEASUREMENT_ITERATIONS, timeUnit = TimeUnit.MILLISECONDS)
 146     public void write100KSingleNodeWithOneInnerItemInOneCommitCursorBenchmark() throws DataValidationFailedException {
 147         final CursorAwareDataTreeModification modification = begin();
 148         try (DataTreeModificationCursor cursor = modification.openCursor(BenchmarkModel.OUTER_LIST_PATH).get()) {
 149             for (int outerListKey = 0; outerListKey < OUTER_LIST_100K; ++outerListKey) {
 150                 cursor.write(OUTER_LIST_IDS[outerListKey], OUTER_LIST_ONE_ITEM_INNER_LIST[outerListKey]);
 151             }
 152         }
 153         commit(modification);
 154     }
 155
 156     @Benchmark
 157     @Warmup(iterations = WARMUP_ITERATIONS, timeUnit = TimeUnit.MILLISECONDS)
 158     @Measurement(iterations = MEASUREMENT_ITERATIONS, timeUnit = TimeUnit.MILLISECONDS)
 159     public void write100KSingleNodeWithOneInnerItemInCommitPerWriteBenchmark() throws DataValidationFailedException {
 160         for (int outerListKey = 0; outerListKey < OUTER_LIST_100K; ++outerListKey) {
 161             final DataTreeModification modification = begin();
 162             modification.write(OUTER_LIST_PATHS[outerListKey], OUTER_LIST_ONE_ITEM_INNER_LIST[outerListKey]);
 163             commit(modification);
 164         }
 165     }
 166
 167     @Benchmark
 168     @Warmup(iterations = WARMUP_ITERATIONS, timeUnit = TimeUnit.MILLISECONDS)
 169     @Measurement(iterations = MEASUREMENT_ITERATIONS, timeUnit = TimeUnit.MILLISECONDS)
 170     public void write50KSingleNodeWithTwoInnerItemsInOneCommitBenchmark() throws DataValidationFailedException {
 171         final DataTreeModification modification = begin();
 172         for (int outerListKey = 0; outerListKey < OUTER_LIST_50K; ++outerListKey) {
 173             modification.write(OUTER_LIST_PATHS[outerListKey], OUTER_LIST_TWO_ITEM_INNER_LIST[outerListKey]);
 174         }
 175         commit(modification);
 176     }
 177
 178     @Benchmark
 179     @Warmup(iterations = WARMUP_ITERATIONS, timeUnit = TimeUnit.MILLISECONDS)
 180     @Measurement(iterations = MEASUREMENT_ITERATIONS, timeUnit = TimeUnit.MILLISECONDS)
 181     public void write50KSingleNodeWithTwoInnerItemsInOneCommitCursorBenchmark() throws DataValidationFailedException {
 182         final CursorAwareDataTreeModification modification = begin();
 183         try (DataTreeModificationCursor cursor = modification.openCursor(BenchmarkModel.OUTER_LIST_PATH).get()) {
 184             for (int outerListKey = 0; outerListKey < OUTER_LIST_50K; ++outerListKey) {
 185                 cursor.write(OUTER_LIST_IDS[outerListKey], OUTER_LIST_TWO_ITEM_INNER_LIST[outerListKey]);
 186             }
 187         }
 188         commit(modification);
 189     }
 190
 191     @Benchmark
 192     @Warmup(iterations = WARMUP_ITERATIONS, timeUnit = TimeUnit.MILLISECONDS)
 193     @Measurement(iterations = MEASUREMENT_ITERATIONS, timeUnit = TimeUnit.MILLISECONDS)
 194     public void write50KSingleNodeWithTwoInnerItemsInCommitPerWriteBenchmark() throws DataValidationFailedException {
 195         for (int outerListKey = 0; outerListKey < OUTER_LIST_50K; ++outerListKey) {
 196             final DataTreeModification modification = begin();
 197             modification.write(OUTER_LIST_PATHS[outerListKey], OUTER_LIST_TWO_ITEM_INNER_LIST[outerListKey]);
 198             commit(modification);
 199         }
 200     }
 201
 202     @Benchmark
 203     @Warmup(iterations = WARMUP_ITERATIONS, timeUnit = TimeUnit.MILLISECONDS)
 204     @Measurement(iterations = MEASUREMENT_ITERATIONS, timeUnit = TimeUnit.MILLISECONDS)
 205     public void write10KSingleNodeWithTenInnerItemsInOneCommitBenchmark() throws DataValidationFailedException {
 206         final DataTreeModification modification = begin();
 207         for (int outerListKey = 0; outerListKey < OUTER_LIST_10K; ++outerListKey) {
 208             modification.write(OUTER_LIST_PATHS[outerListKey], OUTER_LIST_TEN_ITEM_INNER_LIST[outerListKey]);
 209         }
 210         commit(modification);
 211     }
 212
 213     @Benchmark
 214     @Warmup(iterations = WARMUP_ITERATIONS, timeUnit = TimeUnit.MILLISECONDS)
 215     @Measurement(iterations = MEASUREMENT_ITERATIONS, timeUnit = TimeUnit.MILLISECONDS)
 216     public void write10KSingleNodeWithTenInnerItemsInOneCommitCursorBenchmark() throws DataValidationFailedException {
 217         final CursorAwareDataTreeModification modification = begin();
 218         try (DataTreeModificationCursor cursor = modification.openCursor(BenchmarkModel.OUTER_LIST_PATH).get()) {
 219             for (int outerListKey = 0; outerListKey < OUTER_LIST_10K; ++outerListKey) {
 220                 cursor.write(OUTER_LIST_IDS[outerListKey], OUTER_LIST_TEN_ITEM_INNER_LIST[outerListKey]);
 221             }
 222         }
 223         commit(modification);
 224     }
 225
 226     @Benchmark
 227     @Warmup(iterations = WARMUP_ITERATIONS, timeUnit = TimeUnit.MILLISECONDS)
 228     @Measurement(iterations = MEASUREMENT_ITERATIONS, timeUnit = TimeUnit.MILLISECONDS)
 229     public void write10KSingleNodeWithTenInnerItemsInCommitPerWriteBenchmark() throws DataValidationFailedException {
 230         for (int outerListKey = 0; outerListKey < OUTER_LIST_10K; ++outerListKey) {
 231             final DataTreeModification modification = begin();
 232             modification.write(OUTER_LIST_PATHS[outerListKey], OUTER_LIST_TEN_ITEM_INNER_LIST[outerListKey]);
 233             commit(modification);
 234         }
 235     }
 236
 237     private CursorAwareDataTreeModification begin() {
 238         return (CursorAwareDataTreeModification) datastore.takeSnapshot().newModification();
 239     }
 240
 241     private void commit(final DataTreeModification modification) throws DataValidationFailedException {
 242         modification.ready();
 243         datastore.validate(modification);
 244         datastore.commit(datastore.prepare(modification));
 245     }
 246 }