-
Notifications
You must be signed in to change notification settings - Fork 167
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5f23f8d
commit e5b1a19
Showing
12 changed files
with
472 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| name: JMH Example | ||
| on: | ||
| push: | ||
| branches: | ||
| - master | ||
|
|
||
| jobs: | ||
| benchmark: | ||
| name: Run JMH benchmark example | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - uses: actions/setup-java@v2 | ||
| with: | ||
| distribution: 'adopt' | ||
| java-version: '11' | ||
| - name: Run benchmark | ||
| run: | | ||
| cd examples/java | ||
| mvn clean verify | ||
| java -jar target/benchmarks.jar -wi 1 -i 3 -f 1 -rf json | ||
| - name: Store benchmark result | ||
| uses: benchmark-action/github-action-benchmark@v1 | ||
| with: | ||
| name: JMH Benchmark | ||
| tool: 'jmh' | ||
| output-file-path: examples/java/jmh-result.json | ||
| # Use personal access token instead of GITHUB_TOKEN due to https://github.community/t/github-action-not-triggering-gh-pages-upon-push/16096 | ||
| github-token: ${{ secrets.GITHUB_TOKEN }} | ||
| auto-push: true | ||
| # Show alert with commit comment on detecting possible performance regression | ||
| alert-threshold: '200%' | ||
| comment-on-alert: true | ||
| fail-on-alert: true | ||
| alert-comment-cc-users: '@michaelmior' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,3 +10,5 @@ | |
| /coverage | ||
| /dist | ||
| /.idea | ||
| target/ | ||
| jmh-result.json | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,172 @@ | ||
| <!-- | ||
| Copyright (c) 2014, Oracle America, Inc. | ||
| All rights reserved. | ||
| Redistribution and use in source and binary forms, with or without | ||
| modification, are permitted provided that the following conditions are met: | ||
| * Redistributions of source code must retain the above copyright notice, | ||
| this list of conditions and the following disclaimer. | ||
| * Redistributions in binary form must reproduce the above copyright | ||
| notice, this list of conditions and the following disclaimer in the | ||
| documentation and/or other materials provided with the distribution. | ||
| * Neither the name of Oracle nor the names of its contributors may be used | ||
| to endorse or promote products derived from this software without | ||
| specific prior written permission. | ||
| THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | ||
| AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
| ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE | ||
| LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | ||
| CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | ||
| SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | ||
| INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | ||
| CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
| ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF | ||
| THE POSSIBILITY OF SUCH DAMAGE. | ||
| --> | ||
|
|
||
| <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
| xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||
| <modelVersion>4.0.0</modelVersion> | ||
|
|
||
| <groupId>org.openjdk.jmh.samples</groupId> | ||
| <artifactId>jmh-sample</artifactId> | ||
| <version>1.0</version> | ||
| <packaging>jar</packaging> | ||
|
|
||
| <name>JMH benchmark sample: Java</name> | ||
|
|
||
| <!-- | ||
| This is the demo/sample template build script for building Java benchmarks with JMH. | ||
| Edit as needed. | ||
| --> | ||
|
|
||
| <dependencies> | ||
| <dependency> | ||
| <groupId>org.openjdk.jmh</groupId> | ||
| <artifactId>jmh-core</artifactId> | ||
| <version>${jmh.version}</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>org.openjdk.jmh</groupId> | ||
| <artifactId>jmh-generator-annprocess</artifactId> | ||
| <version>${jmh.version}</version> | ||
| <scope>provided</scope> | ||
| </dependency> | ||
| </dependencies> | ||
|
|
||
| <properties> | ||
| <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> | ||
|
|
||
| <!-- | ||
| JMH version to use with this project. | ||
| --> | ||
| <jmh.version>1.29</jmh.version> | ||
|
|
||
| <!-- | ||
| Java source/target to use for compilation. | ||
| --> | ||
| <javac.target>1.8</javac.target> | ||
|
|
||
| <!-- | ||
| Name of the benchmark Uber-JAR to generate. | ||
| --> | ||
| <uberjar.name>benchmarks</uberjar.name> | ||
| </properties> | ||
|
|
||
| <build> | ||
| <plugins> | ||
| <plugin> | ||
| <groupId>org.apache.maven.plugins</groupId> | ||
| <artifactId>maven-compiler-plugin</artifactId> | ||
| <version>3.8.0</version> | ||
| <configuration> | ||
| <compilerVersion>${javac.target}</compilerVersion> | ||
| <source>${javac.target}</source> | ||
| <target>${javac.target}</target> | ||
| </configuration> | ||
| </plugin> | ||
| <plugin> | ||
| <groupId>org.apache.maven.plugins</groupId> | ||
| <artifactId>maven-shade-plugin</artifactId> | ||
| <version>3.2.1</version> | ||
| <executions> | ||
| <execution> | ||
| <phase>package</phase> | ||
| <goals> | ||
| <goal>shade</goal> | ||
| </goals> | ||
| <configuration> | ||
| <finalName>${uberjar.name}</finalName> | ||
| <transformers> | ||
| <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer"> | ||
| <mainClass>org.openjdk.jmh.Main</mainClass> | ||
| </transformer> | ||
| <transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/> | ||
| </transformers> | ||
| <filters> | ||
| <filter> | ||
| <!-- | ||
| Shading signed JARs will fail without this. | ||
| http://stackoverflow.com/questions/999489/invalid-signature-file-when-attempting-to-run-a-jar | ||
| --> | ||
| <artifact>*:*</artifact> | ||
| <excludes> | ||
| <exclude>META-INF/*.SF</exclude> | ||
| <exclude>META-INF/*.DSA</exclude> | ||
| <exclude>META-INF/*.RSA</exclude> | ||
| </excludes> | ||
| </filter> | ||
| </filters> | ||
| </configuration> | ||
| </execution> | ||
| </executions> | ||
| </plugin> | ||
| </plugins> | ||
| <pluginManagement> | ||
| <plugins> | ||
| <plugin> | ||
| <artifactId>maven-clean-plugin</artifactId> | ||
| <version>2.5</version> | ||
| </plugin> | ||
| <plugin> | ||
| <artifactId>maven-deploy-plugin</artifactId> | ||
| <version>2.8.1</version> | ||
| </plugin> | ||
| <plugin> | ||
| <artifactId>maven-install-plugin</artifactId> | ||
| <version>2.5.1</version> | ||
| </plugin> | ||
| <plugin> | ||
| <artifactId>maven-jar-plugin</artifactId> | ||
| <version>2.4</version> | ||
| </plugin> | ||
| <plugin> | ||
| <artifactId>maven-javadoc-plugin</artifactId> | ||
| <version>2.9.1</version> | ||
| </plugin> | ||
| <plugin> | ||
| <artifactId>maven-resources-plugin</artifactId> | ||
| <version>2.6</version> | ||
| </plugin> | ||
| <plugin> | ||
| <artifactId>maven-site-plugin</artifactId> | ||
| <version>3.3</version> | ||
| </plugin> | ||
| <plugin> | ||
| <artifactId>maven-source-plugin</artifactId> | ||
| <version>2.2.1</version> | ||
| </plugin> | ||
| <plugin> | ||
| <artifactId>maven-surefire-plugin</artifactId> | ||
| <version>2.17</version> | ||
| </plugin> | ||
| </plugins> | ||
| </pluginManagement> | ||
| </build> | ||
|
|
||
| </project> |
92 changes: 92 additions & 0 deletions
92
examples/java/src/main/java/org/openjdk/jmh/samples/JMHSample_01_HelloWorld.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| /* | ||
| * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. | ||
| * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. | ||
| * | ||
| * This code is free software; you can redistribute it and/or modify it | ||
| * under the terms of the GNU General Public License version 2 only, as | ||
| * published by the Free Software Foundation. Oracle designates this | ||
| * particular file as subject to the "Classpath" exception as provided | ||
| * by Oracle in the LICENSE file that accompanied this code. | ||
| * | ||
| * This code is distributed in the hope that it will be useful, but WITHOUT | ||
| * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | ||
| * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | ||
| * version 2 for more details (a copy is included in the LICENSE file that | ||
| * accompanied this code). | ||
| * | ||
| * You should have received a copy of the GNU General Public License version | ||
| * 2 along with this work; if not, write to the Free Software Foundation, | ||
| * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. | ||
| * | ||
| * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA | ||
| * or visit www.oracle.com if you need additional information or have any | ||
| * questions. | ||
| */ | ||
| package org.openjdk.jmh.samples; | ||
|
|
||
| import org.openjdk.jmh.annotations.Benchmark; | ||
| import org.openjdk.jmh.runner.Runner; | ||
| import org.openjdk.jmh.runner.RunnerException; | ||
| import org.openjdk.jmh.runner.options.Options; | ||
| import org.openjdk.jmh.runner.options.OptionsBuilder; | ||
|
|
||
| public class JMHSample_01_HelloWorld { | ||
|
|
||
| /* | ||
| * This is our first benchmark method. | ||
| * | ||
| * The contract for the benchmark methods is very simple: | ||
| * annotate it with @Benchmark, and you are set to go. | ||
| * JMH will run the test by continuously calling this method, and measuring | ||
| * the performance metrics for its execution. | ||
| * | ||
| * The method names are non-essential, it matters they are marked with | ||
| * @Benchmark. You can have multiple benchmark methods | ||
| * within the same class. | ||
| * | ||
| * Note: if the benchmark method never finishes, then JMH run never | ||
| * finishes as well. If you throw the exception from the method body, | ||
| * the JMH run ends abruptly for this benchmark, and JMH will run | ||
| * the next benchmark down the list. | ||
| * | ||
| * Although this benchmark measures "nothing", it is the good showcase | ||
| * for the overheads the infrastructure bear on the code you measure | ||
| * in the method. There are no magical infrastructures which incur no | ||
| * overhead, and it's important to know what are the infra overheads | ||
| * you are dealing with. You might find this thought unfolded in future | ||
| * examples by having the "baseline" measurements to compare against. | ||
| */ | ||
|
|
||
| @Benchmark | ||
| public void wellHelloThere() { | ||
| // this method was intentionally left blank. | ||
| } | ||
|
|
||
| /* | ||
| * ============================== HOW TO RUN THIS TEST: ==================================== | ||
| * | ||
| * You are expected to see the run with large number of iterations, and | ||
| * very large throughput numbers. You can see that as the estimate of the | ||
| * harness overheads per method call. In most of our measurements, it is | ||
| * down to several cycles per call. | ||
| * | ||
| * a) Via command-line: | ||
| * $ mvn clean install | ||
| * $ java -jar target/benchmarks.jar ".*JMHSample_01.*" | ||
| * | ||
| * JMH generates self-contained JARs, bundling JMH together with it. | ||
| * The runtime options for the JMH are available with "-h": | ||
| * $ java -jar target/benchmarks.jar -h | ||
| * | ||
| * b) Via Java API: | ||
| */ | ||
|
|
||
| public static void main(String[] args) throws RunnerException { | ||
| Options opt = new OptionsBuilder() | ||
| .include(".*" + JMHSample_01_HelloWorld.class.getSimpleName() + ".*") | ||
| .forks(1) | ||
| .build(); | ||
|
|
||
| new Runner(opt).run(); | ||
| } | ||
| } |
Oops, something went wrong.