fastutil-concurrent-wrapper/src/jmh/java/com/trivago/kangaroo/AbstractCommonBenchHelper.java at 604e138a0b13854b2a86c89b6f49ccb749ec6806 · magicprinc/fastutil-concurrent-wrapper · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
package com.trivago.kangaroo;

import org.openjdk.jmh.annotations.Benchmark;
import org.openjdk.jmh.annotations.BenchmarkMode;
import org.openjdk.jmh.annotations.Mode;
import org.openjdk.jmh.annotations.OutputTimeUnit;
import org.openjdk.jmh.annotations.Threads;

import java.util.concurrent.TimeUnit;

public abstract class AbstractCommonBenchHelper {
    /**
     * Benchmarks the throughput of the "get" operation.
     *
     * <p>This method executes the testGet() operation using the throughput mode and measures its performance
     * with 4 concurrent threads.
     */
    @Threads(4)
    @Benchmark
    @BenchmarkMode(Mode.Throughput)
    public void testRandomGetThroughput() {
        testGet();
    }

    @Threads(4)
    @Benchmark
    @BenchmarkMode(Mode.Throughput)
    public void testRandomPutThroughput() {
        testPut();
    }

    @Threads(4)
    @Benchmark
    @BenchmarkMode(Mode.Throughput)
    public void testRandomAllOpsThroughput() {
        testAllOps();
    }

    @Threads(4)
    @Benchmark
    @BenchmarkMode(Mode.AverageTime)
    @OutputTimeUnit(TimeUnit.NANOSECONDS)
    public void testRandomGetAvgTime() {
        testGet();
    }

    @Threads(4)
    @Benchmark
    @BenchmarkMode(Mode.AverageTime)
    @OutputTimeUnit(TimeUnit.NANOSECONDS)
    public void testRandomPutAvgTime() {
        testPut();
    }

    /**
     * Measures the average execution time of all operations.
     * <p>
     * Executes the {@code testAllOps()} method across four concurrent threads
     * and reports the average execution time in nanoseconds.
     * </p>
     */
    @Threads(4)
    @Benchmark
    @BenchmarkMode(Mode.AverageTime)
    @OutputTimeUnit(TimeUnit.NANOSECONDS)
    public void testRandomAllOpsAvgTime() {
        testAllOps();
    }

    /**
 * Executes the GET operation benchmark.
 *
 * <p>This abstract method should be implemented by subclasses to perform the GET operation,
 * which is used in benchmarking tests to measure performance metrics such as throughput and average execution time.</p>
 */
public abstract void testGet();

    /**
 * Executes a put operation for benchmarking purposes.
 *
 * <p>Implementations should override this method to define the logic for a put operation,
 * which will be measured by throughput and average execution time benchmarks.</p>
 */
public abstract void testPut();

    /**
 * Executes a comprehensive set of benchmark operations.
 *
 * <p>This abstract method should be implemented to perform a mixed workload—typically combining
 * get and put operations—to simulate a realistic full-spectrum scenario. It is invoked during
 * benchmarking runs to measure both throughput and average execution time in multi-threaded environments.
 */
public abstract void testAllOps();
}