Merge pull request #330 from graalvm/compiler-category

[GR-60094] Review and update Java Streams Benchmark demo; moved to compiler demos category.

Author: olyagpl

…rkflows/java-simple-stream-benchmark.yml …flows/compiler-java-stream-benchmark.yml.github/workflows/java-simple-stream-benchmark.yml renamed to .github/workflows/compiler-java-stream-benchmark.yml .github/workflows/java-simple-stream-benchmark.yml renamed to .github/workflows/compiler-java-stream-benchmark.yml

@@ -1,35 +1,34 @@
-name: java-simple-stream-benchmark
+name: compiler/java-stream-benchmark
 on:
   push:
     paths:
-      - 'java-simple-stream-benchmark/**'
-      - '.github/workflows/java-simple-stream-benchmark.yml'
+      - 'compiler/java-stream-benchmark/**'
+      - '.github/workflows/compiler-java-stream-benchmark.yml'
   pull_request:
     paths:
-      - 'java-simple-stream-benchmark/**'
-      - '.github/workflows/java-simple-stream-benchmark.yml'
+      - 'compiler/java-stream-benchmark/**'
+      - '.github/workflows/compiler-java-stream-benchmark.yml'
   schedule:
     - cron: "0 0 1 * *" # run every month
   workflow_dispatch:
 permissions:
   contents: read
 jobs:
   run:
-    name: Run 'java-simple-stream-benchmark'
+    name: Run 'compiler/java-stream-benchmark'
     runs-on: ubuntu-latest
     timeout-minutes: 15
     strategy:
       matrix:
-        java-version: ['21', 'dev']
+        java-version: ['21', '23.0.1']
     steps:
       - uses: actions/checkout@v4
       - uses: graalvm/setup-graalvm@v1
         with:
           java-version: ${{ matrix.java-version }}
           distribution: 'graalvm'
           github-token: ${{ secrets.GITHUB_TOKEN }}
-      - name: Run 'java-simple-stream-benchmark'
+      - name: Run 'compiler/java-stream-benchmark'
         run: |
-          cd java-simple-stream-benchmark
-          ./build.sh
+          cd compiler/java-stream-benchmark
           ./run.sh

README.md

@@ -43,10 +43,6 @@ cd graalvm-demos
       <td align="left" width="30%"><a href="/native-image/list-files/">native-image/list-files</a><br><a href="https://github.com/graalvm/graalvm-demos/actions/workflows/native-image-list-files.yml"><img alt="native-image/list-files" src="https://github.com/graalvm/graalvm-demos/actions/workflows/native-image-list-files.yml/badge.svg"/></a></td>
       <td align="left" width="70%">Demonstrates how to compile a CLI application into a native executable and then apply Profile-Guided Optimizations (PGO) for more performance gains<br><strong>Technologies: </strong>Native Image, PGO
     </tr>
-    <tr>
-      <td align="left" width="30%"><a href="/java-simple-stream-benchmark/">java-simple-stream-benchmark</a><br><a href="https://github.com/graalvm/graalvm-demos/actions/workflows/java-simple-stream-benchmark.yml"><img alt="java-simple-stream-benchmark" src="https://github.com/graalvm/graalvm-demos/actions/workflows/java-simple-stream-benchmark.yml/badge.svg" /></a></td>
-      <td align="left" width="70%">Demonstrates how the Graal compiler can achieve better performance for highly abstracted programs like those using Streams, Lambdas<br><strong>Technologies: </strong>Graal compiler, C2<br><strong>Reference: </strong><a href="https://luna.oracle.com/lab/d502417b-df66-45be-9fed-a3ac8e3f09b1/steps#task-2-run-demos-java-microbenchmark-harness-jmh">Simple Java Stream Benchmark</a></td>
-    </tr>
     <tr>
       <td align="left" width="30%"><a href="/multithreading-demo/">multithreading-demo</a><br><a href="https://github.com/graalvm/graalvm-demos/actions/workflows/streams.yml"><img alt="streams" src="https://github.com/graalvm/graalvm-demos/actions/workflows/streams.yml/badge.svg" /></a></td>
       <td align="left" width="70%">Demonstrates how to optimize a Java application that does synchronous and asynchronous threads execution<br><strong>Technologies: </strong>Native Image Build Reports, Native Build Tools Maven plugin <br><strong>Reference: </strong><a href="https://medium.com/graalvm/making-sense-of-native-image-contents-741a688dab4d">Making sense of Native Image contents</a></td>

compiler/java-stream-benchmark/.mvn/wrapper/maven-wrapper.properties

@@ -0,0 +1,18 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.5/apache-maven-3.8.5-bin.zip
+wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar

compiler/java-stream-benchmark/README.md

@@ -0,0 +1,63 @@
+# Java Stream Benchmark
+
+This repository contains the code for a simple Java Stream benchmark designed to run on the [GraalVM JDK](http://graalvm.org) and the [Oracle JDK](https://www.oracle.com/java/technologies/downloads/).
+## Preparation
+
+1. Download and install the GraalVM JDK using [SDKMAN!](https://sdkman.io/). For other installation options, visit the [Downloads page](https://www.graalvm.org/downloads/).
+    ```bash
+    sdk install java 23.0.1-graal
+    ```
+
+2. Download or clone the repository and navigate into the benchmark directory:
+    ```bash
+    git clone https://github.com/graalvm/graalvm-demos
+    ```
+    ```bash
+    cd graalvm-demos/compiler/java-stream-benchmark
+    ```
+
+## Build the Benchmark
+
+Build the benchmark with Maven:
+```bash
+./mvnw package
+```
+Now you can run this benchmark with whatever `java` you have on your machine and compare the results between JVMs.
+
+> **A note about the results**: The benchmark mode is the `AverageTime` in nanoseconds per operation, which means lower numbers are better.
+Note that the results you see can be influenced by the hardware you are running this benchmark on, the CPU load, and other factors.
+Interpret them responsibly.
+
+### GraalVM JDK with Graal JIT
+
+Run the benchmark with the default GraalVM JIT compiler by executing the _target/benchmarks.jar_ file:
+```bash
+java -jar target/benchmarks.jar
+```
+
+### GraalVM JDK with Graal JIT Deactivated
+
+Now deactivate the Graal compiler and run the benchmark on the same JVM (GraalVM):
+```bash
+java -XX:-UseJVMCICompiler -jar target/benchmarks.jar
+```
+This way, the Graal JIT compiler is not be used as the JVMCI compiler and the JVM uses its default one (C2).
+
+### Oracle JDK with Graal JIT
+
+Note that starting with Oracle JDK 23, the **Oracle GraalVM JIT compiler (Graal JIT) is now included among the JITs available as part of the Oracle JDK**.
+Read more in [this blog post](https://blogs.oracle.com/java/post/including-the-graal-jit-in-oracle-jdk-23).
+
+1. Switch the JVM from GraalVM (Oracle GraalVM or Community Edition) to Oracle JDK 23 or higher. You can quickly do that with using [SDKMAN!](https://sdkman.io/):
+    ```bash
+    sdk install java 23.0.1-oracle 
+    ```
+
+2. Run this benchmark with the Graal JIT compiler enabled. For that, pass the `-XX:+UseGraalJIT` option to `java`:
+    ```bash
+    java -XX:+UnlockExperimentalVMOptions -XX:+UseGraalJIT -jar target/benchmarks.jar
+    ```
+
+> To switch between JVMs in the same terminal window (without affecting the global setting), use the `sdk` tool. For example, to switch back to Oracle GraalVM for JDK 23, run: `sdk use java 23.0.1-graal`.
+
+Learn more about the Graal JIT compiler from [its official documentation](https://www.graalvm.org/reference-manual/java/compiler/).