Merge branch 'master' into check-fragmentation-immixspace

Author: qinsoon

.github/scripts/ci-common.sh

@@ -1,10 +1,17 @@
-arch=`rustc --print cfg | grep target_arch | cut -f2 -d"\""`
-os=`rustc --print cfg | grep target_os | cut -f2 -d"\""`
+# Note: cargo-rustc is influenced by the environment variable CARGO_BUILD_TARGET
+# which is specified in minimal-tests-core.yml
+arch=`cargo rustc -- --print cfg | grep target_arch | cut -f2 -d"\""`
+os=`cargo rustc -- --print cfg | grep target_os | cut -f2 -d"\""`
 
 project_root=$(dirname "$0")/../..
 
 cargo_toml=$project_root/Cargo.toml
 
+dummyvm_toml=$project_root/docs/dummyvm/Cargo.toml
+
+# Pin certain deps for our MSRV
+cargo update -p [email protected] --precise 0.5.5 # This can be removed once we move to Rust 1.81 or newer
+
 # Repeat a command for all the features. Requires the command as one argument (with double quotes)
 for_all_features() {
     # without mutually exclusive features

.github/scripts/ci-doc.sh

@@ -22,6 +22,10 @@ if ! cat $project_root/src/plan/mod.rs | grep -q "pub mod mygc;"; then
 fi
 cargo build
 
-# Install mdbook using the stable toolchain
-cargo +stable install mdbook
+# Check dummyvm in portingguide
+cargo build --manifest-path $dummyvm_toml
+
+# Install mdbook using the stable toolchain and the default target
+unset CARGO_BUILD_TARGET
+cargo +stable install mdbook mdbook-admonish mdbook-hide
 mdbook build $project_root/docs/userguide

.github/scripts/ci-style.sh

@@ -2,43 +2,63 @@
 
 export RUSTFLAGS="-D warnings -A unknown-lints"
 
+# --- Check format ---
+cargo fmt -- --check
+cargo fmt --manifest-path=macros/Cargo.toml -- --check
+
 # Workaround the clippy issue on Rust 1.72: https://github.com/mmtk/mmtk-core/issues/929.
 # If we are not testing with Rust 1.72, or there is no problem running the following clippy checks, we can remove this export.
 CLIPPY_VERSION=$(cargo clippy --version)
 if [[ $CLIPPY_VERSION == "clippy 0.1.72"* ]]; then
     export CARGO_INCREMENTAL=0
 fi
 
+if [[ $CLIPPY_VERSION == "clippy 0.1.77"* && $CARGO_BUILD_TARGET == "x86_64-apple-darwin" ]]; then
+    export SKIP_CLIPPY=1
+fi
+
 # --- Check main crate ---
 
-# check base
-cargo clippy
-# check all features
-for_all_features "cargo clippy"
-# check release
-for_all_features "cargo clippy --release"
-# check for tests
-for_all_features "cargo clippy --tests"
-
-# target-specific features
-if [[ $arch == "x86_64" && $os == "linux" ]]; then
-    cargo clippy --features perf_counter
-    cargo clippy --release --features perf_counter
-    cargo clippy --tests --features perf_counter
-fi
+if [[ $SKIP_CLIPPY == 1 ]]; then
+    echo "Skipping clippy version $CLIPPY_VERSION on $CARGO_BUILD_TARGET"
+else
+    # check base
+    cargo clippy
+    # check all features
+    for_all_features "cargo clippy"
+    # check release
+    for_all_features "cargo clippy --release"
+    # check for tests
+    for_all_features "cargo clippy --tests"
 
-# mock tests
-cargo clippy --features mock_test
-cargo clippy --features mock_test --tests
-cargo clippy --features mock_test --benches
+    # target-specific features
+    if [[ $arch == "x86_64" && $os == "linux" ]]; then
+        cargo clippy --features perf_counter
+        cargo clippy --release --features perf_counter
+        cargo clippy --tests --features perf_counter
+    fi
+
+    # mock tests
+    cargo clippy --features mock_test
+    cargo clippy --features mock_test --tests
+    cargo clippy --features mock_test --benches
+
+    # non-mock benchmarks
+    cargo clippy --features test_private --benches
+fi
 
 # --- Check auxiliary crate ---
 
 style_check_auxiliary_crate() {
     crate_path=$1
 
-    cargo clippy --manifest-path=$crate_path/Cargo.toml
-    cargo fmt --manifest-path=$crate_path/Cargo.toml -- --check
+    if [[ $SKIP_CLIPPY == 1 ]]; then
+        echo "Skipping clippy test for $crate_path"
+    else
+        cargo clippy --manifest-path=$crate_path/Cargo.toml
+        cargo fmt --manifest-path=$crate_path/Cargo.toml -- --check
+    fi
 }
 
 style_check_auxiliary_crate macros
+style_check_auxiliary_crate docs/dummyvm

.github/scripts/ci-test.sh

@@ -37,3 +37,6 @@ find ./src ./tests -type f -name "mock_test_*" | while read -r file; do
         env MMTK_PLAN=$MMTK_PLAN cargo test --features mock_test,"$FEATURES" -- $t;
     done
 done
+
+# Test the dummy VM
+cargo test --manifest-path $dummyvm_toml

.github/workflows/api-check.yml

@@ -19,32 +19,43 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout mmtk-core
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           # Full git history needed
           fetch-depth: 0
 
-      # cargo-public-api can be built with the latest stable toolchain.
-      - name: Install stable Rust toolchain
-        uses: actions-rs/toolchain@v1
-        with:
-          toolchain: stable
-          profile: minimal
-          # make it the active toolchain
-          override: true
-
       # cargo-public-api needs a nightly toolchain installed in order to work.
       # It does not have to be the active toolchain.
       - name: Install nightly Rust toolchain
-        uses: actions-rs/toolchain@v1
-        with:
-          toolchain: nightly
-          profile: minimal
+        run: rustup toolchain install nightly
 
+      # Show the Rust toolchain we are actually using
+      - run: rustup show
       - run: cargo --version
       - run: cargo +nightly --version
 
       - name: Install cargo-public-api
-        run: cargo install cargo-public-api
+        run: cargo +nightly install cargo-public-api
       - name: API Diff
-        run: cargo public-api diff origin/${GITHUB_BASE_REF}..${{ github.event.pull_request.head.sha }} --deny=all
+        run: cargo +nightly public-api diff origin/${GITHUB_BASE_REF}..${{ github.event.pull_request.head.sha }} --deny=all
+
+  check-api-migration-update:
+    needs: check-public-api-changes
+    runs-on: ubuntu-latest
+    if: ${{ always() && needs.check-public-api-changes.result == 'failure'}}
+    env:
+      MIGRATION_GUIDE_PATH: 'docs/userguide/src/migration/**'
+    steps:
+      # Check if migration guide is updated.
+      - name: Get the update status for the migration guide.
+        uses: tj-actions/changed-files@v44
+        id: migration-guide-status
+        with:
+          files: ${{ env.MIGRATION_GUIDE_PATH }}
+      # If the api check failed but the migration is not updated, we fail here
+      - name: Report if the migration guide is not updated.
+        if: ${{ steps.migration-guide-status.outputs.any_changed == 'false' }}
+        uses: actions/github-script@v7
+        with:
+          script: |
+            core.setFailed('Public API is changed, but the migration guide (${{ env.MIGRATION_GUIDE_PATH }}) is not updated. If the bindings need to be updated for the API change, the migration guide needs to be updated as well.')

.github/workflows/auto-merge-inner.yml

@@ -15,6 +15,10 @@ on:
       ref:
         required: true
         type: string
+      # The upstream branch where the binding PR is targeting, such as master, dev
+      base_ref:
+        required: true
+        type: string
       # The core commit hash that the binding should be using.
       core_commit:
         required: true
@@ -35,7 +39,7 @@ jobs:
       - name: Check input conditions
         id: check-input
         run: |
-          if [[ "${{ inputs.repo }}" == ${{ inputs.base_repo }} ]] && [[ "${{ inputs.ref }}" == "master" ]]; then
+          if [[ "${{ inputs.repo }}" == ${{ inputs.base_repo }} ]] && [[ "${{ inputs.ref }}" == "${{ inputs.base_ref }}" ]]; then
             echo "Conditions not met"
             echo "skip=true" >> $GITHUB_OUTPUT
           else
@@ -44,13 +48,13 @@ jobs:
         shell: bash
 
       - name: Checkout MMTk Core
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         if: steps.check-input.outputs.skip == 'false'
         with:
           path: ${{ env.MMTK_CORE_WORK_DIR }}
       - name: Checkout repository
         if: steps.check-input.outputs.skip == 'false'
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           repository: ${{ inputs.repo }}
           path: ${{ env.BINDING_WORK_DIR }}

.github/workflows/auto-merge.yml

@@ -36,8 +36,9 @@ jobs:
     needs: [get-merged-pr, binding-refs]
     with:
       repo: ${{ needs.binding-refs.outputs.openjdk_binding_repo }}
-      base_repo: mmtk/mmtk-openjdk
+      base_repo: ${{ needs.binding-refs.outputs.openjdk_binding_repo_default }}
       ref: ${{ needs.binding-refs.outputs.openjdk_binding_ref }}
+      base_ref: ${{ needs.binding-refs.outputs.openjdk_binding_ref_default }}
       core_commit: ${{ needs.get-merged-pr.outputs.commit }}
       update_lockfile: cargo build
     secrets: inherit
@@ -47,8 +48,9 @@ jobs:
     needs: [get-merged-pr, binding-refs]
     with:
       repo: ${{ needs.binding-refs.outputs.jikesrvm_binding_repo }}
-      base_repo: mmtk/mmtk-jikesrvm
+      base_repo: ${{ needs.binding-refs.outputs.jikesrvm_binding_repo_default }}
       ref: ${{ needs.binding-refs.outputs.jikesrvm_binding_ref }}
+      base_ref: ${{ needs.binding-refs.outputs.jikesrvm_binding_ref_default }}
       core_commit: ${{ needs.get-merged-pr.outputs.commit }}
       # `cargo generate-lockfile` will update other dependencies. We avoid using it for the bindings.
       # But we do not have a good option for JikesRVM. The Rust project in JikesRVM needs some source files
@@ -62,8 +64,9 @@ jobs:
     needs: [get-merged-pr, binding-refs]
     with:
       repo: ${{ needs.binding-refs.outputs.v8_binding_repo }}
-      base_repo: mmtk/mmtk-v8
+      base_repo: ${{ needs.binding-refs.outputs.v8_binding_repo_default }}
       ref: ${{ needs.binding-refs.outputs.v8_binding_ref }}
+      base_ref: ${{ needs.binding-refs.outputs.v8_binding_ref_default }}
       core_commit: ${{ needs.get-merged-pr.outputs.commit }}
       update_lockfile: cargo build --features nogc
     secrets: inherit
@@ -73,19 +76,24 @@ jobs:
     needs: [get-merged-pr, binding-refs]
     with:
       repo: ${{ needs.binding-refs.outputs.julia_binding_repo }}
-      base_repo: mmtk/mmtk-julia
+      base_repo: ${{ needs.binding-refs.outputs.julia_binding_repo_default }}
       ref: ${{ needs.binding-refs.outputs.julia_binding_ref }}
+      base_ref: ${{ needs.binding-refs.outputs.julia_binding_ref_default }}
       core_commit: ${{ needs.get-merged-pr.outputs.commit }}
-      update_lockfile: cargo build --features immix
+      # `cargo generate-lockfile` will update other dependencies. We avoid using it for the bindings.
+      # mmtk-julia uses bindgen during building and requires the Julia repo. This is a similar situation
+      # as mmtk-jikesrvm. To make thigns simpler, we just use `cargo generate-lockfile`.
+      update_lockfile: cargo generate-lockfile
     secrets: inherit
 
   check-merge-ruby-pr:
     uses: ./.github/workflows/auto-merge-inner.yml
     needs: [get-merged-pr, binding-refs]
     with:
       repo: ${{ needs.binding-refs.outputs.ruby_binding_repo }}
-      base_repo: mmtk/mmtk-ruby
+      base_repo: ${{ needs.binding-refs.outputs.ruby_binding_repo_default }}
       ref: ${{ needs.binding-refs.outputs.ruby_binding_ref }}
+      base_ref: ${{ needs.binding-refs.outputs.ruby_binding_ref_default }}
       core_commit: ${{ needs.get-merged-pr.outputs.commit }}
       update_lockfile: cargo build
     secrets: inherit

.github/workflows/binding-tests-openjdk.yml

@@ -18,11 +18,11 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
         - name: Checkout MMTk Core
-          uses: actions/checkout@v2
+          uses: actions/checkout@v4
           with:
             path: mmtk-core
         - name: Checkout OpenJDK Binding
-          uses: actions/checkout@v2
+          uses: actions/checkout@v4
           with:
             repository: ${{ inputs.repo }}
             path: mmtk-openjdk

.github/workflows/cargo-msrv.yml

@@ -17,18 +17,19 @@ jobs:
   msrv:
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v2
-      - name: Install Rust toolchain
-        uses: actions-rs/toolchain@v1
-        with:
-          toolchain: stable
-          override: true
+      - uses: actions/checkout@v4
+
+      # Show the Rust toolchain we are actually using
+      - run: rustup show
+      - run: cargo --version
+
       - name: Install cargo-msrv
-        run: cargo install cargo-msrv
+        # The cargo-msrv tool sometimes requires a higher Rust version than our current rust-toolchain.
+        run: cargo +stable install cargo-msrv
       # Verify the MSRV defined in Cargo.toml
       - name: Verify MSRV
         run: cargo msrv verify
       # If the previous step fails, find MSRV
       - name: Find MSRV
         if: failure()
-        run: cargo msrv
+        run: cargo msrv find

.github/workflows/cargo-publish.yml

@@ -14,14 +14,12 @@ jobs:
   cargo-publish:
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v2
-      - name: Install latest nightly
-        uses: actions-rs/toolchain@v1
-        with:
-          components: rustfmt, clippy
-          target: i686-unknown-linux-gnu
-          # This overwrites the default toolchain with the toolchain specified above.
-          override: true
+      - uses: actions/checkout@v4
+
+      # Show the Rust toolchain we are actually using
+      - run: rustup show
+      - run: cargo --version
+
       - name: Cargo login
         run: cargo login ${{ secrets.CI_CARGO_LOGIN }}
       - name: Publish sub crates