Add JMH benchmarks for model-data

6 files changed, 177 insertions, 2 deletions

diff --git a/gradle.properties b/gradle.properties
index 8b4f3793..542a8766 100644
--- a/gradle.properties
+++ b/gradle.properties
@@ -2,6 +2,7 @@ ecoreVersion=2.24.0
 ecoreCodegenVersion=2.26.0
 hamcrestVersion=2.2
 jettyVersion=9.4.42.v20210604
+jmhVersion=1.32
 junitVersion=5.7.2
 mweVersion=1.6.1
 mwe2Version=2.12.1
diff --git a/gradle/java-common.gradle b/gradle/java-common.gradle
index 24df4201..caae7d78 100644
--- a/gradle/java-common.gradle
+++ b/gradle/java-common.gradle
@@ -52,9 +52,9 @@ eclipse {
                         }
                 }
         }
-        
+
         jdt.file.whenMerged { properties ->
-                // Allow @SupperessWarnings to suppress SonalLint warnings
+                // Allow @SupperessWarnings to suppress SonarLint warnings
                 properties['org.eclipse.jdt.core.compiler.problem.unhandledWarningToken'] = 'ignore'
         }
 }
diff --git a/gradle/jmh.gradle b/gradle/jmh.gradle
new file mode 100644
index 00000000..ea88f3e3
--- /dev/null
+++ b/gradle/jmh.gradle
@@ -0,0 +1,40 @@
+configurations {
+        jmh {
+                extendsFrom compile
+        }
+}
+
+sourceSets {
+        jmh {
+                java.srcDirs = ['src/jmh/java']
+        resources.srcDirs = ['src/jmh/resources']
+        compileClasspath += sourceSets.main.runtimeClasspath
+        compileClasspath += sourceSets.test.runtimeClasspath
+        xtendOutputDir = 'src/jmh/xtend-gen'
+        }
+}
+
+dependencies {
+        jmhRuntime "org.openjdk.jmh:jmh-core:${jmhVersion}"
+        jmhCompile "org.openjdk.jmh:jmh-generator-annprocess:${jmhVersion}"
+        jmhAnnotationProcessor "org.openjdk.jmh:jmh-generator-annprocess:${jmhVersion}"
+}
+
+clean.doLast {
+        delete 'src/jmh/xtend-gen'
+}
+
+task jmh(type: JavaExec, dependsOn: jmhClasses) {
+    main = 'org.openjdk.jmh.Main'
+    classpath = sourceSets.jmh.compileClasspath + sourceSets.jmh.runtimeClasspath
+}
+
+eclipse.classpath {
+        plusConfigurations += [configurations.jmh]
+
+        // Allow test helper classes to be used in benchmarks from Eclipse.
+        file.whenMerged { classpath ->
+                def jmhClasspathEntry = classpath.entries.find { entry -> entry.path == 'src/jmh/java' }
+                jmhClasspathEntry.entryAttributes['test'] = true
+        }
+}
diff --git a/model-data/build.gradle b/model-data/build.gradle
index 49056339..56d64de9 100644
--- a/model-data/build.gradle
+++ b/model-data/build.gradle
@@ -1,4 +1,5 @@
 apply from: "${rootDir}/gradle/java-common.gradle"
+apply from: "${rootDir}/gradle/jmh.gradle"
 
 dependencies {
         testCompile "org.junit.jupiter:junit-jupiter-api:${junitVersion}"
diff --git a/model-data/src/jmh/java/org/eclipse/viatra/solver/data/map/benchmarks/ImmutablePutBenchmark.java b/model-data/src/jmh/java/org/eclipse/viatra/solver/data/map/benchmarks/ImmutablePutBenchmark.java
new file mode 100644
index 00000000..f0af443f
--- /dev/null
+++ b/model-data/src/jmh/java/org/eclipse/viatra/solver/data/map/benchmarks/ImmutablePutBenchmark.java
@@ -0,0 +1,77 @@
+package org.eclipse.viatra.solver.data.map.benchmarks;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.concurrent.TimeUnit;
+
+import org.openjdk.jmh.annotations.Benchmark;
+import org.openjdk.jmh.annotations.BenchmarkMode;
+import org.openjdk.jmh.annotations.Fork;
+import org.openjdk.jmh.annotations.Measurement;
+import org.openjdk.jmh.annotations.Mode;
+import org.openjdk.jmh.annotations.OutputTimeUnit;
+import org.openjdk.jmh.annotations.Warmup;
+import org.openjdk.jmh.infra.Blackhole;
+
+@Fork(1)
+@BenchmarkMode(Mode.AverageTime)
+@OutputTimeUnit(TimeUnit.MILLISECONDS)
+@Measurement(time = 1, timeUnit = TimeUnit.SECONDS)
+@Warmup(time = 1, timeUnit = TimeUnit.SECONDS)
+public class ImmutablePutBenchmark {
+        @Benchmark
+        public void immutablePutBenchmark(ImmutablePutExecutionPlan executionPlan, Blackhole blackhole) {
+                var sut = executionPlan.createSut();
+                for (int i = 0; i < executionPlan.nPut; i++) {
+                        sut.put(executionPlan.nextKey(), executionPlan.nextValue());
+                }
+                blackhole.consume(sut);
+        }
+
+        @Benchmark
+        public void immutablePutAndCommitBenchmark(ImmutablePutExecutionPlan executionPlan, Blackhole blackhole) {
+                var sut = executionPlan.createSut();
+                for (int i = 0; i < executionPlan.nPut; i++) {
+                        sut.put(executionPlan.nextKey(), executionPlan.nextValue());
+                        if (i % 10 == 0) {
+                                blackhole.consume(sut.commit());
+                        }
+                }
+                blackhole.consume(sut);
+        }
+
+        @Benchmark
+        public void baselinePutBenchmark(ImmutablePutExecutionPlan executionPlan, Blackhole blackhole) {
+                var sut = new HashMap<Integer, String>();
+                for (int i = 0; i < executionPlan.nPut; i++) {
+                        var key = executionPlan.nextKey();
+                        var value = executionPlan.nextValue();
+                        if (executionPlan.isDefault(value)) {
+                                sut.remove(key);
+                        } else {
+                                sut.put(key, value);
+                        }
+                }
+                blackhole.consume(sut);
+        }
+
+        @Benchmark
+        public void baselinePutAndCommitBenchmark(ImmutablePutExecutionPlan executionPlan, Blackhole blackhole) {
+                var sut = new HashMap<Integer, String>();
+                var store = new ArrayList<HashMap<Integer, String>>();
+                for (int i = 0; i < executionPlan.nPut; i++) {
+                        var key = executionPlan.nextKey();
+                        var value = executionPlan.nextValue();
+                        if (executionPlan.isDefault(value)) {
+                                sut.remove(key);
+                        } else {
+                                sut.put(key, value);
+                        }
+                        if (i % 10 == 0) {
+                                store.add(new HashMap<>(sut));
+                        }
+                }
+                blackhole.consume(sut);
+                blackhole.consume(store);
+        }
+}
diff --git a/model-data/src/jmh/java/org/eclipse/viatra/solver/data/map/benchmarks/ImmutablePutExecutionPlan.java b/model-data/src/jmh/java/org/eclipse/viatra/solver/data/map/benchmarks/ImmutablePutExecutionPlan.java
new file mode 100644
index 00000000..6cac74af
--- /dev/null
+++ b/model-data/src/jmh/java/org/eclipse/viatra/solver/data/map/benchmarks/ImmutablePutExecutionPlan.java
@@ -0,0 +1,56 @@
+package org.eclipse.viatra.solver.data.map.benchmarks;
+
+import java.util.Random;
+
+import org.eclipse.viatra.solver.data.map.ContinousHashProvider;
+import org.eclipse.viatra.solver.data.map.VersionedMapStore;
+import org.eclipse.viatra.solver.data.map.VersionedMapStoreImpl;
+import org.eclipse.viatra.solver.data.map.internal.VersionedMapImpl;
+import org.eclipse.viatra.solver.data.map.tests.utils.MapTestEnvironment;
+import org.openjdk.jmh.annotations.Level;
+import org.openjdk.jmh.annotations.Param;
+import org.openjdk.jmh.annotations.Scope;
+import org.openjdk.jmh.annotations.Setup;
+import org.openjdk.jmh.annotations.State;
+
+@State(Scope.Benchmark)
+public class ImmutablePutExecutionPlan {
+
+        @Param({ "100", "10000" })
+        public int nPut;
+
+        @Param({ "32", "1000", "100000" })
+        public int nKeys;
+
+        @Param({ "2", "3" })
+        public int nValues;
+
+        private Random random;
+
+        private String[] values;
+
+        private ContinousHashProvider<Integer> hashProvider = MapTestEnvironment.prepareHashProvider(false);
+
+        @Setup(Level.Trial)
+        public void setUpTrial() {
+                random = new Random();
+                values = MapTestEnvironment.prepareValues(nValues);
+        }
+
+        public VersionedMapImpl<Integer, String> createSut() {
+                VersionedMapStore<Integer, String> store = new VersionedMapStoreImpl<Integer, String>(hashProvider, values[0]);
+                return (VersionedMapImpl<Integer, String>) store.createMap();
+        }
+
+        public Integer nextKey() {
+                return random.nextInt(nKeys);
+        }
+
+        public boolean isDefault(String value) {
+                return value == values[0];
+        }
+
+        public String nextValue() {
+                return values[random.nextInt(nValues)];
+        }
+}