Fix CI scripts for OpenJDK 21

wks · wks · commit f2b9a1a71eff · 2025-04-25T16:11:21.000+08:00
This changes paths build options, etc., to make the CI scripts work with
OpenJDK 21.

We now use a single source of truth for the OpenJDK path instead of
defining OPENJDK_PATH in multiple scripts.
diff --git a/.github/scripts/ci-build.sh b/.github/scripts/ci-build.sh
@@ -13,4 +13,4 @@ build_target=$1
 # Build product bundle
 cd $OPENJDK_PATH
 sh configure --disable-warnings-as-errors --with-debug-level=$DEBUG_LEVEL
-make CONF=linux-x86_64-normal-server-$DEBUG_LEVEL THIRD_PARTY_HEAP=$BINDING_PATH/openjdk $OPENJDK_BUILD_TARGET
+make CONF=linux-x86_64-server-$DEBUG_LEVEL THIRD_PARTY_HEAP=$BINDING_PATH/openjdk $OPENJDK_BUILD_TARGET
diff --git a/.github/scripts/ci-checkout.sh b/.github/scripts/ci-checkout.sh
@@ -1,14 +1,10 @@
-# ci-checkout.sh
 set -ex
 
 . $(dirname "$0")/common.sh
 
 OPENJDK_URL=`cargo read-manifest --manifest-path=$BINDING_PATH/mmtk/Cargo.toml | python3 -c 'import json,sys; print(json.load(sys.stdin)["metadata"]["openjdk"]["openjdk_repo"])'`
 OPENJDK_VERSION=`cargo read-manifest --manifest-path=$BINDING_PATH/mmtk/Cargo.toml | python3 -c 'import json,sys; print(json.load(sys.stdin)["metadata"]["openjdk"]["openjdk_version"])'`
 
-# Use default openjdk path if it is not set (this is only need when MMTk core calls the script)
-OPENJDK_PATH=${OPENJDK_PATH:="$BINDING_PATH/repos/openjdk"}
-
 rm -rf $OPENJDK_PATH
 git clone $OPENJDK_URL $OPENJDK_PATH
 git -C $OPENJDK_PATH checkout $OPENJDK_VERSION
diff --git a/.github/scripts/ci-setup.sh b/.github/scripts/ci-setup.sh
@@ -2,7 +2,7 @@ set -xe
 
 . $(dirname "$0")/common.sh
 
-# Install nightly rust
+# Install the appropriate Rust toolchain
 rustup toolchain install $RUSTUP_TOOLCHAIN
 rustup target add i686-unknown-linux-gnu --toolchain $RUSTUP_TOOLCHAIN
 rustup component add clippy --toolchain $RUSTUP_TOOLCHAIN
diff --git a/.github/scripts/ci-test-extended.sh b/.github/scripts/ci-test-extended.sh
@@ -3,11 +3,13 @@ set -ex
 . $(dirname "$0")/common.sh
 cur=$BINDING_PATH/.github/scripts
 
+# This script runs against a specific pre-built java binary, not OpenJDK source code.
+ensure_env TEST_JAVA_BIN
+unset OPENJDK_PATH
+
 # This script is only used by MMTk core.
-# OPENJDK_PATH is the default path set in ci-checkout.sh
-export OPENJDK_PATH=$BINDING_PATH/repos/openjdk
 export DEBUG_LEVEL=fastdebug
-export TEST_JAVA_BIN=$OPENJDK_PATH/build/linux-x86_64-normal-server-$DEBUG_LEVEL/jdk/bin/java
+export TEST_JAVA_BIN=$OPENJDK_PATH/build/linux-x86_64-server-$DEBUG_LEVEL/jdk/bin/java
 
 # Download dacapo
 export DACAPO_PATH=$BINDING_PATH/dacapo
diff --git a/.github/scripts/ci-test-minimal.sh b/.github/scripts/ci-test-minimal.sh
@@ -4,10 +4,8 @@ set -ex
 cur=$BINDING_PATH/.github/scripts
 
 # This script is only used by MMTk core.
-# OPENJDK_PATH is the default path set in ci-checkout.sh
-export OPENJDK_PATH=$BINDING_PATH/repos/openjdk
 export DEBUG_LEVEL=fastdebug
-export TEST_JAVA_BIN=$OPENJDK_PATH/build/linux-x86_64-normal-server-$DEBUG_LEVEL/jdk/bin/java
+export TEST_JAVA_BIN=$OPENJDK_PATH/build/linux-x86_64-server-$DEBUG_LEVEL/jdk/bin/java
 
 # Download dacapo
 export DACAPO_PATH=$BINDING_PATH/dacapo
diff --git a/.github/scripts/ci-test-only-normal.sh b/.github/scripts/ci-test-only-normal.sh
@@ -4,6 +4,10 @@ set -xe
 
 unset JAVA_TOOL_OPTIONS
 
+# This script runs against a specific pre-built java binary, not OpenJDK source code.
+ensure_env TEST_JAVA_BIN
+unset OPENJDK_PATH
+
 run_all() {
     heap_multiplier=$1
 
diff --git a/.github/scripts/ci-test-only-weak-ref.sh b/.github/scripts/ci-test-only-weak-ref.sh
@@ -3,7 +3,10 @@ set -xe
 . $(dirname "$0")/common.sh
 
 unset JAVA_TOOL_OPTIONS
-cd $OPENJDK_PATH
+
+# This script runs against a specific pre-built java binary, not OpenJDK source code.
+ensure_env TEST_JAVA_BIN
+unset OPENJDK_PATH
 
 export MMTK_NO_REFERENCE_TYPES=false
 # Just test Immix and MarkCompact
diff --git a/.github/scripts/common.sh b/.github/scripts/common.sh
@@ -1,6 +1,10 @@
 BINDING_PATH=$(realpath $(dirname "$0"))/../..
 RUSTUP_TOOLCHAIN=`cat $BINDING_PATH/mmtk/rust-toolchain`
 
+# build.yml specifies the OPENJDK_PATH env var when calling ci-build.sh
+# But other scripts expect a default path for OpenJDK.
+OPENJDK_PATH=${OPENJDK_PATH:="$BINDING_PATH/repos/jdk"}
+
 # dacapo2006 min heap for mark compact
 MINHEAP_ANTLR=5
 MINHEAP_FOP=13
diff --git a/.github/scripts/pgo-build.sh b/.github/scripts/pgo-build.sh
@@ -11,13 +11,13 @@ cargo clean
 popd
 
 # Compile with profiling support
-RUSTFLAGS="-Cprofile-generate=/tmp/$USER/pgo-data" make CONF=linux-x86_64-normal-server-release THIRD_PARTY_HEAP=$PWD/../mmtk-openjdk/openjdk images
+RUSTFLAGS="-Cprofile-generate=/tmp/$USER/pgo-data" make CONF=linux-x86_64-server-release THIRD_PARTY_HEAP=$PWD/../mmtk-openjdk/openjdk images
 
 # Remove extraneous profiling data
 rm -rf /tmp/$USER/pgo-data/*
 
 # Profile using fop
-MMTK_PLAN=GenImmix MMTK_STRESS_FACTOR=16777216 MMTK_PRECISE_STRESS=false ./build/linux-x86_64-normal-server-release/images/jdk/bin/java -XX:MetaspaceSize=500M -XX:+DisableExplicitGC -XX:-TieredCompilation -Xcomp -XX:+UseThirdPartyHeap -Xms60M -Xmx60M -jar /usr/share/benchmarks/dacapo/dacapo-23.9-RC3-chopin.jar -n 5 fop
+MMTK_PLAN=GenImmix MMTK_STRESS_FACTOR=16777216 MMTK_PRECISE_STRESS=false ./build/linux-x86_64-server-release/images/jdk/bin/java -XX:MetaspaceSize=500M -XX:+DisableExplicitGC -XX:-TieredCompilation -Xcomp -XX:+UseThirdPartyHeap -Xms60M -Xmx60M -jar /usr/share/benchmarks/dacapo/dacapo-23.9-RC3-chopin.jar -n 5 fop
 
 # Merge profiling data
 /opt/rust/toolchains/1.71.1-x86_64-unknown-linux-gnu/lib/rustlib/x86_64-unknown-linux-gnu/bin/llvm-profdata merge -o /tmp/$USER/pgo-data/merged.profdata /tmp/$USER/pgo-data
@@ -27,4 +27,4 @@ cargo clean
 popd
 
 # Compile using profiling data
-RUSTFLAGS="-Cprofile-use=/tmp/$USER/pgo-data/merged.profdata -Cllvm-args=-pgo-warn-missing-function" make CONF=linux-x86_64-normal-server-release THIRD_PARTY_HEAP=$PWD/../mmtk-openjdk/openjdk images
+RUSTFLAGS="-Cprofile-use=/tmp/$USER/pgo-data/merged.profdata -Cllvm-args=-pgo-warn-missing-function" make CONF=linux-x86_64-server-release THIRD_PARTY_HEAP=$PWD/../mmtk-openjdk/openjdk images
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -20,24 +20,19 @@ jobs:
   build-linux-x64:
     name: linux-x64
     runs-on: ubuntu-22.04
+    env:
+      # This overrides OPENJDK_PATH in ci-common.sh
+      # Note: We cannot use default environment variables (GITHUB_*) in the "env" context.  Use github.* instead.
+      # See: https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables#default-environment-variables
+      OPENJDK_PATH: ${{ github.workspace }}/git/openjdk
     steps:
     - name: Checkout MMTk OpenJDK binding
       uses: actions/checkout@v4
       with:
         path: ./git/mmtk-openjdk
-    - name: Extract OpenJDK revision
-      id: extract-openjdk-revision
-      run: |
-        OPENJDK_VERSION=`sed -n 's/^openjdk_version.=."\(.*\)"$/\1/p' < git/mmtk-openjdk/mmtk/Cargo.toml`
-        echo "openjdk-revision=$OPENJDK_VERSION" >> $GITHUB_OUTPUT
     - name: Checkout OpenJDK
-      uses: actions/checkout@v4
-      with:
-        repository: mmtk/openjdk
-        path: ./git/openjdk
-        ref: ${{ steps.extract-openjdk-revision.outputs.openjdk-revision }}
-    # Patch mmtk-core version if needed
-    - name: Patch mmtk-core version
+      run: ./git/mmtk-openjdk/.github/scripts/ci-checkout.sh
+    - name: Patch mmtk-core version if needed
       if: ${{ inputs.mmtk-core-repo != '' || inputs.mmtk-core-ref != '' }}
       run: |
         pip3 install tomlkit
@@ -60,14 +55,16 @@ jobs:
           echo "BUILD_SUFFIX=$escaped_build" >> $GITHUB_ENV
         fi
     - name: Build MMTk OpenJDK ${{ inputs.debug-level }}
-      run: |
-        OPENJDK_PATH=$GITHUB_WORKSPACE/git/openjdk DEBUG_LEVEL=${{ inputs.debug-level }} OPENJDK_BUILD_TARGET=product-bundles ./.github/scripts/ci-build.sh
+      env:
+        DEBUG_LEVEL: ${{ inputs.debug-level }}
+        OPENJDK_BUILD_TARGET: product-bundles
+      run: ./.github/scripts/ci-build.sh
       working-directory: ./git/mmtk-openjdk
     - name: Upload bundles
       uses: actions/upload-artifact@v4
       with:
         name: linux-x86_64-server-${{ inputs.debug-level }}-bundles-${{ env.BUILD_SUFFIX }}
         path: |
-          ./git/openjdk/build/linux-x86_64-normal-server-${{ inputs.debug-level }}/bundles/*_bin.tar.gz
-          ./git/openjdk/build/linux-x86_64-normal-server-${{ inputs.debug-level }}/bundles/*_bin-debug.tar.gz
+          ./git/openjdk/build/linux-x86_64-server-${{ inputs.debug-level }}/bundles/*_bin.tar.gz
+          ./git/openjdk/build/linux-x86_64-server-${{ inputs.debug-level }}/bundles/*_bin-debug.tar.gz
         retention-days: 2
diff --git a/README.md b/README.md
@@ -56,7 +56,7 @@ You would need our OpenJDK fork which includes the support for a third party hea
 
 Assuming your current working directory is the parent folder of `mmtk-openjdk`, you can checkout out OpenJDK and the correct version using:
 ```console
-$ git clone https://github.com/mmtk/openjdk.git
+$ git clone https://github.com/mmtk/jdk.git
 $ git -C openjdk checkout `sed -n 's/^openjdk_version.=."\(.*\)"$/\1/p' < mmtk-openjdk/mmtk/Cargo.toml`
 ```
 
@@ -113,17 +113,17 @@ $ sh configure --disable-warnings-as-errors --with-debug-level=$DEBUG_LEVEL
 Then build OpenJDK (this will build MMTk as well):
 
 ```console
-$ make CONF=linux-x86_64-normal-server-release THIRD_PARTY_HEAP=$PWD/../mmtk-openjdk/openjdk images
+$ make CONF=linux-x86_64-server-release THIRD_PARTY_HEAP=$PWD/../mmtk-openjdk/openjdk images
 ```
 
-The output jdk is then found at `./build/linux-x86_64-normal-server-release/images/jdk`.
+The output jdk is then found at `./build/linux-x86_64-server-release/images/jdk`.
 
 > **Note:** The above `make` command will build the `images` target, which is a proper release build of OpenJDK. It is **essential** that you use this target if you are planning on evaluating your build (e.g. measuring performance, gathering minimum heap values, etc). However, if you are simply developing and building incremental changes often, you may want to use the [`default` target or "exploded image"](https://github.com/openjdk/jdk11u/blob/master/doc/building.md#Running-make), which has a marginally shorter build time. However, be wary, as the exploded image is the (roughly) minimal set of outputs required to run the built JDK and is not guaranteed to run all benchmarks. It may have bloated minimum heap values as well.
 > 
-> The exploded image can be built as follows. The output jdk can be found at `./build/linux-x86_64-normal-server-$DEBUG_LEVEL/jdk`.
+> The exploded image can be built as follows. The output jdk can be found at `./build/linux-x86_64-server-$DEBUG_LEVEL/jdk`.
 >
 > ```console
-> $ make CONF=linux-x86_64-normal-server-$DEBUG_LEVEL THIRD_PARTY_HEAP=$PWD/../mmtk-openjdk/openjdk
+> $ make CONF=linux-x86_64-server-$DEBUG_LEVEL THIRD_PARTY_HEAP=$PWD/../mmtk-openjdk/openjdk
 > ```
 >
 > Again: **do not use the exploded image for performance analysis**.
@@ -151,7 +151,7 @@ stress factor of 4 MB in order to trigger more GC events.
 First we compile MMTk with profiling support:
 
 ```console
-$ RUSTFLAGS="-Cprofile-generate=/tmp/$USER/pgo-data" make CONF=linux-x86_64-normal-server-release THIRD_PARTY_HEAP=$PWD/../mmtk-openjdk/openjdk images
+$ RUSTFLAGS="-Cprofile-generate=/tmp/$USER/pgo-data" make CONF=linux-x86_64-server-release THIRD_PARTY_HEAP=$PWD/../mmtk-openjdk/openjdk images
 $ rm -rf /tmp/$USER/pgo-data/*
 ```
 We clear the `/tmp/$USER/pgo-data` directory as during compilation, the JVM we
@@ -162,7 +162,7 @@ We then run `fop` in order to get some profiling data. Note that your location
 for the DaCapo benchmarks may be different:
 
 ```bash
-MMTK_PLAN=GenImmix MMTK_STRESS_FACTOR=4194304 MMTK_PRECISE_STRESS=false ./build/linux-x86_64-normal-server-release/images/jdk/bin/java -XX:MetaspaceSize=500M -XX:+DisableExplicitGC -XX:-TieredCompilation -Xcomp -XX:+UseThirdPartyHeap -Xms60M -Xmx60M -jar /usr/share/benchmarks/dacapo/dacapo-evaluation-git-6e411f33.jar -n 5 fop
+MMTK_PLAN=GenImmix MMTK_STRESS_FACTOR=4194304 MMTK_PRECISE_STRESS=false ./build/linux-x86_64-server-release/images/jdk/bin/java -XX:MetaspaceSize=500M -XX:+DisableExplicitGC -XX:-TieredCompilation -Xcomp -XX:+UseThirdPartyHeap -Xms60M -Xmx60M -jar /usr/share/benchmarks/dacapo/dacapo-evaluation-git-6e411f33.jar -n 5 fop
 ```
 
 We have to merge the profiling data into something we can feed into the Rust
@@ -179,11 +179,11 @@ your Rust version.*
 Finally, we build a new image using the profiling data as an input:
 
 ```console
-$ RUSTFLAGS="-Cprofile-use=/tmp/$USER/pgo-data/merged.profdata -Cllvm-args=-pgo-warn-missing-function" make CONF=linux-x86_64-normal-server-release THIRD_PARTY_HEAP=$PWD/../mmtk-openjdk/openjdk images
+$ RUSTFLAGS="-Cprofile-use=/tmp/$USER/pgo-data/merged.profdata -Cllvm-args=-pgo-warn-missing-function" make CONF=linux-x86_64-server-release THIRD_PARTY_HEAP=$PWD/../mmtk-openjdk/openjdk images
 ```
 
 We now have an OpenJDK build under
-`./build/linux-x86_64-normal-server-release/images/jdk` with MMTk that has been
+`./build/linux-x86_64-server-release/images/jdk` with MMTk that has been
 optimized using PGO.
 
 For ease of use, we have provided an example script which does the above in
@@ -197,7 +197,7 @@ metadata), but by setting the environment variable `MMTK_MARK_IN_HEADER=1` while
 building OpenJDK, we can change its location to be in the object's header:
 
 ```console
-$ MMTK_MARK_IN_HEADER=1 make CONF=linux-x86_64-normal-server-$DEBUG_LEVEL THIRD_PARTY_HEAP=$PWD/../mmtk-openjdk/openjdk
+$ MMTK_MARK_IN_HEADER=1 make CONF=linux-x86_64-server-$DEBUG_LEVEL THIRD_PARTY_HEAP=$PWD/../mmtk-openjdk/openjdk
 ```
 
 ### Valid object bit
@@ -207,7 +207,7 @@ environment variable `MMTK_VO_BIT=1` when building OpenJDK. This will set the fe
 for mmtk-core, as well as compiling the fastpath for the VO bit.
 
 ```console
-$ MMTK_VO_BIT=1 make CONF=linux-x86_64-normal-server-$DEBUG_LEVEL THIRD_PARTY_HEAP=$PWD/../mmtk-openjdk/openjdk
+$ MMTK_VO_BIT=1 make CONF=linux-x86_64-server-$DEBUG_LEVEL THIRD_PARTY_HEAP=$PWD/../mmtk-openjdk/openjdk
 ```
 
 ## Test
@@ -221,8 +221,8 @@ class HelloWorld {
         System.out.println("Hello World!");
     }
 }
-$ ./build/linux-x86_64-normal-server-$DEBUG_LEVEL/jdk/bin/javac HelloWorld.java
-$ ./build/linux-x86_64-normal-server-$DEBUG_LEVEL/jdk/bin/java HelloWorld
+$ ./build/linux-x86_64-server-$DEBUG_LEVEL/jdk/bin/javac HelloWorld.java
+$ ./build/linux-x86_64-server-$DEBUG_LEVEL/jdk/bin/java HelloWorld
 Hello World!
 ```
 
@@ -231,7 +231,7 @@ Hello World!
 Pass `-XX:+UseThirdPartyHeap` as java command line arguments to enable MMTk.
 
 ```
-$ ./build/linux-x86_64-normal-server-$DEBUG_LEVEL/jdk/bin/java -XX:+UseThirdPartyHeap HelloWorld
+$ ./build/linux-x86_64-server-$DEBUG_LEVEL/jdk/bin/java -XX:+UseThirdPartyHeap HelloWorld
 ```
 
 If `DEBUG_LEVEL` is `release`, you should just see
@@ -266,7 +266,7 @@ $ wget https://sourceforge.net/projects/dacapobench/files/9.12-bach-MR1/dacapo-9
 Run a DaCapo benchmark (e.g. `lusearch`):
 
 ```console
-$ ./build/linux-x86_64-normal-server-$DEBUG_LEVEL/jdk/bin/java -XX:+UseThirdPartyHeap -Xms512M -Xmx512M -jar ./dacapo-9.12-MR1-bach.jar lusearch
+$ ./build/linux-x86_64-server-$DEBUG_LEVEL/jdk/bin/java -XX:+UseThirdPartyHeap -Xms512M -Xmx512M -jar ./dacapo-9.12-MR1-bach.jar lusearch
 Using scaled threading model. 24 processors detected, 24 threads used to drive the workload, in a possible range of [1,64]
 ===== DaCapo 9.12-MR1 lusearch starting =====
 4 query batches completed
diff --git a/TESTING-legacy.md b/TESTING-legacy.md
@@ -34,8 +34,8 @@ cargo +nightly build
 cd ..
 # Build OpenJDK
 bash configure --disable-warnings-as-errors --with-debug-level=<DEBUG_LEVEL>
-CONF=linux-x86_64-normal-server-<DEBUG_LEVEL> make
-# JDK is at `build/linux-x86_64-normal-server-<DEBUG_LEVEL>/jdk`
+CONF=linux-x86_64-server-<DEBUG_LEVEL> make
+# JDK is at `build/linux-x86_64-server-<DEBUG_LEVEL>/jdk`
 ```
 
 ## Building (release)
@@ -48,13 +48,13 @@ cargo +nightly build --release
 cd ..
 # Build OpenJDK
 bash configure --disable-warnings-as-errors
-CONF=linux-x86_64-normal-server-release make
-# JDK is at `build/linux-x86_64-normal-server-release/jdk`
+CONF=linux-x86_64-server-release make
+# JDK is at `build/linux-x86_64-server-release/jdk`
 ```
 
 ## Testing
 
-1. `java` binary is at `build/linux-x86_64-normal-server-<DEBUG_LEVEL>/jdk/bin/java`.
+1. `java` binary is at `build/linux-x86_64-server-<DEBUG_LEVEL>/jdk/bin/java`.
 2. Set env `LD_LIBRARY_PATH` to include `$PWD/mmtk/vmbindings/openjdk/target/debug` (or `$PWD/mmtk/vmbindings/openjdk/target/release` if openjdk is built with debug level `release`).
 3. To enable MMTk, pass `-XX:+UseMMTk -XX:-UseCompressedOops` to `java`.
 
@@ -63,13 +63,13 @@ e.g.:
 * If `DEBUG_LEVEL` = `fastdebug`, `slowdebug` or `optimized`:
 ```bash
 export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$PWD/mmtk/vmbindings/openjdk/target/debug
-build/linux-x86_64-normal-server-fastdebug/jdk/bin/java -XX:+UseMMTk -XX:-UseCompressedOops HelloWorld
+build/linux-x86_64-server-fastdebug/jdk/bin/java -XX:+UseMMTk -XX:-UseCompressedOops HelloWorld
 ```
 
 * If `DEBUG_LEVEL` = `release`:
 ```bash
 export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$PWD/mmtk/vmbindings/openjdk/target/release
-build/linux-x86_64-normal-server-release/jdk/bin/java -XX:+UseMMTk -XX:-UseCompressedOops HelloWorld
+build/linux-x86_64-server-release/jdk/bin/java -XX:+UseMMTk -XX:-UseCompressedOops HelloWorld
 ```
 
 > Original instructions by Abdullah Al Mamun and Tanveer Hannan
diff --git a/mmtk/Cargo.toml b/mmtk/Cargo.toml
@@ -16,7 +16,7 @@ lto = true
 
 # Metadata for the OpenJDK repository
 [package.metadata.openjdk]
-# Our CI matches the following line and extract mmtk/openjdk. If this line is updated, please check ci yaml files and make sure it works.
+# Our CI matches the following line and extract mmtk/jdk. If this line is updated, please check ci yaml files and make sure it works.
 openjdk_repo = "https://github.com/mmtk/jdk.git"
 openjdk_version = "2632c4f7b5366bed4d0cb91ea5ffe93541a70e30"
 
