Promote linux aarch64 to tier 1 support (Qiskit#13737)

* Promote linux aarch64 to tier 1 support

With native linux aarch64 runners available from github now available
[1] we can run tests on every PR on the platform and promote it to tier
1 support [2]. This commit adds a github action test job that runs on
PRs to test that the platform works on every commit. Then the wheel job
is promoted to the tier 1 job which includes PGO which will improve the
performance on the wheels we publish for the platform.

While there is a larger effort to migrate our entire CI to github
actions in Qiskit#13474 expanding our test matrix prior to that won't cause
a conflict as we can easily expand the test matrix in that PR if this
merges first.

[1]: https://github.blog/changelog/2025-01-16-linux-arm64-hosted-runners-now-available-for-free-in-public-repositories-public-preview/
[2]: https://docs.quantum.ibm.com/guides/install-qiskit#operating-system-support

* Update job name for test job

* Try latest manylinux image for arm

* Use url for image path

* Try without explicit latest tag

* Tweak rust install script

* Revert "Try without explicit latest tag"

This reverts commit d39b6ee.

* Split out aarch64 tier 1 job to separate job

The aarch64 wheel builds are failing with PGO on latest stable (and
stable - 1). This is likely either an issue in rustc or the llvm tools
component from rustup on the later releases. But it seems to build fine
with our MSRV. We build with latest stable for release jobs typically to
enable the improvements from the latest compiler for what we publish.
But PGO has enough benefit that using our MSRV is fine if that is what's
necessary.

* Remove duplicate tier 1 arm job

* Try different target string to fix profile version mismatch

* Tweak msrv install again

* Only install a single rust toolchain in aarch64 env

* Deduplicate job definitions

* Add comment about msrv location

* Remove stale comment

* Fix release notes typo

* Adjust run script

* Set rust toolchain to msrv in build

Author: mtreinish

.github/workflows/tests.yml

@@ -13,19 +13,15 @@ concurrency:
 jobs:
   tests:
     if: github.repository_owner == 'Qiskit'
-    name: macOS-arm64-tests-Python-${{ matrix.python-version }}
-    runs-on: macOS-14
+    name: ${{ matrix.os }}-arm64-tests-Python-${{ matrix.python-version }}
+    runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
-        # Normally we test min and max version but we can't run python
-        # 3.9 on arm64 until actions/setup-python#808 is resolved
-        python-version: ["3.10", "3.13"]
+        python-version: ["3.9", "3.13"]
+        os: ["macOS-14", "ubuntu-24.04-arm"]
     steps:
       - uses: actions/checkout@v4
-      - name: Install Rust toolchain
-        uses: dtolnay/[email protected]
-        if: matrix.python-version == '3.10'
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
@@ -36,7 +32,7 @@ jobs:
           python -m pip install -U -r requirements.txt -c constraints.txt
           python -m pip install -U -r requirements-dev.txt -c constraints.txt
           python -m pip install -c constraints.txt -e .
-        if: matrix.python-version == '3.10'
+        if: matrix.python-version == '3.9'
         env:
           QISKIT_NO_CACHE_GATES: 1
       - name: 'Install dependencies'
@@ -49,6 +45,6 @@ jobs:
         run: |
           python -m pip install -r requirements-optional.txt -c constraints.txt
           python tools/report_numpy_state.py
-        if: matrix.python-version == '3.10'
+        if: matrix.python-version == '3.9'
       - name: 'Run tests'
         run: stestr run

.github/workflows/wheels-build.yml

@@ -43,14 +43,6 @@ on:
         default: "default"
         required: false
 
-      wheels-linux-aarch64:
-        description: >-
-          The action to take for Linux AArch64 wheels.
-          Choose from 'default', 'build' or 'skip'.
-        type: string
-        default: "default"
-        required: false
-
       artifact-prefix:
         description: "A prefix to give all artifacts uploaded with 'actions/upload-artifact'."
         type: string
@@ -85,12 +77,12 @@ jobs:
           # Used for the ARM builds.
           - macos-14
           - windows-latest
+          - ubuntu-24.04-arm
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
           python-version: ${{ inputs.python-version }}
-          architecture: ${{ matrix.os == 'macos-14' && 'arm64' || 'x64' }}
       - uses: dtolnay/rust-toolchain@stable
         with:
           components: llvm-tools-preview
@@ -108,12 +100,19 @@ jobs:
         run: |
           set -e
           mkdir -p "$PGO_WORK_DIR"
-
+          if [[ `uname -m` == "aarch64" ]] ; then
+              INSTALL_RUST_PATH=tools/install_rust_msrv.sh
+              RUST_TOOLCHAIN=1.79
+          else
+              INSTALL_RUST_PATH=tools/install_rust.sh
+              RUST_TOOLCHAIN=stable
+          fi
           cat >>"$GITHUB_ENV" <<EOF
+          CIBW_BEFORE_ALL_LINUX=yum install -y wget && {package}/$INSTALL_RUST_PATH
           CIBW_BEFORE_BUILD=bash ./tools/build_pgo.sh $PGO_WORK_DIR $PGO_OUT_PATH
           CIBW_ENVIRONMENT=RUSTUP_TOOLCHAIN=stable RUSTFLAGS='-Cprofile-use=$PGO_OUT_PATH -Cllvm-args=-pgo-warn-missing-function'
           CIBW_ENVIRONMENT_MACOS=MACOSX_DEPLOYMENT_TARGET='10.12' RUSTUP_TOOLCHAIN=stable RUSTFLAGS='-Cprofile-use=$PGO_OUT_PATH -Cllvm-args=-pgo-warn-missing-function'
-          CIBW_ENVIRONMENT_LINUX=RUSTUP_TOOLCHAIN=stable RUSTFLAGS='-Cprofile-use=$PGO_OUT_PATH -Cllvm-args=-pgo-warn-missing-function' PATH="\$PATH:\$HOME/.cargo/bin" CARGO_NET_GIT_FETCH_WITH_CLI="true"
+          CIBW_ENVIRONMENT_LINUX=RUSTUP_TOOLCHAIN=$RUST_TOOLCHAIN RUSTFLAGS='-Cprofile-use=$PGO_OUT_PATH -Cllvm-args=-pgo-warn-missing-function' PATH="\$PATH:\$HOME/.cargo/bin" CARGO_NET_GIT_FETCH_WITH_CLI="true"
           EOF
         env:
           PGO_WORK_DIR: ${{ github.workspace }}/pgo-data
@@ -123,7 +122,6 @@ jobs:
         with:
           path: ./wheelhouse/*.whl
           name: ${{ inputs.artifact-prefix }}wheels-tier-1-${{ matrix.os }}
-
   wheels-linux-s390x:
     name: "Wheels / Linux s390x"
     if: (inputs.wheels-linux-s390x == 'default' && inputs.default-action || inputs.wheels-linux-s390x) == 'build'
@@ -170,22 +168,6 @@ jobs:
           path: ./wheelhouse/*.whl
           name: ${{ inputs.artifact-prefix }}wheels-linux-ppc64le
 
-  wheels-linux-aarch64:
-    name: "Wheels / Linux AArch64"
-    if: (inputs.wheels-linux-aarch64 == 'default' && inputs.default-action || inputs.wheels-linux-aarch64) == 'build'
-    runs-on: ubuntu-24.04-arm
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
-        with:
-          python-version: ${{ inputs.python-version }}
-      - uses: dtolnay/rust-toolchain@stable
-      - uses: pypa/[email protected]
-      - uses: actions/upload-artifact@v4
-        with:
-          path: ./wheelhouse/*.whl
-          name: ${{ inputs.artifact-prefix }}wheels-linux-aarch64
-
   sdist:
     name: "sdist"
     if: (inputs.sdist == 'default' && inputs.default-action || inputs.sdist) == 'build'

Cargo.toml

@@ -5,7 +5,7 @@ resolver = "2"
 [workspace.package]
 version = "2.0.0"
 edition = "2021"
-rust-version = "1.79"  # Keep in sync with README.md and rust-toolchain.toml.
+rust-version = "1.79"  # Keep in sync with README.md, rust-toolchain.toml, and tools/install_rust_msrv.sh
 license = "Apache-2.0"
 
 # Shared dependencies that can be inherited.  This just helps a little with

pyproject.toml

@@ -165,7 +165,7 @@ target-version = ['py39', 'py310', 'py311']
 
 [tool.cibuildwheel]
 manylinux-x86_64-image = "manylinux2014"
-manylinux-i686-image = "manylinux2014"
+manylinux-aarch64-image = "quay.io/pypa/manylinux2014_aarch64:latest"
 skip = "pp* cp36-* cp37-* cp38-* *musllinux* *win32 *i686 cp38-macosx_arm64"
 test-skip = "*win32 *linux_i686"
 test-command = "cp -r {project}/test . && QISKIT_PARALLEL=FALSE stestr --test-path test/python run --abbreviate"

releasenotes/notes/arm-linux-tier1-fa79edaabf565685.yaml

@@ -0,0 +1,8 @@
+---
+features:
+  - |
+    Support for the Linux aarch64 platform has been promoted to tier 1 support as documented in:
+
+    https://docs.quantum.ibm.com/guides/install-qiskit#operating-system-support
+
+    from its previous support level of tier 2 in the 1.x release series.

tools/install_rust.sh

@@ -2,5 +2,6 @@
 if [ ! -d rust-installer ]; then
     mkdir rust-installer
     wget https://sh.rustup.rs -O rust-installer/rustup.sh
-    sh rust-installer/rustup.sh -y -c llvm-tools-preview
+    sh rust-installer/rustup.sh -y -c llvm-tools
 fi
+. "$HOME/.cargo/env"

tools/install_rust_msrv.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+if [ ! -d rust-installer ]; then
+    mkdir rust-installer
+    wget https://sh.rustup.rs -O rust-installer/rustup.sh
+    sh rust-installer/rustup.sh -y -c llvm-tools
+    rustup default 1.79
+    rustup component add llvm-tools
+    rustup uninstall stable
+fi
+. "$HOME/.cargo/env"