chore(prover): Fixes broken non-GPU setup (#2953)

Previously, this was done via a compile flag. This was deemed poor taste and we've moved a specific env-var - `ZKSYNC_USE_CUDA_STUBS`. This is wired deep within crypto dependencies. This PR updates the dependencies, adds documentation on how to work with the flag and updates all workflows (fixing the broken ones from RUSTFLAGS time). --------- Co-authored-by: Igor Aleksanov <[email protected]>
matter-labs · Sep 25, 2024 · 2edd8a2 · 2edd8a2
1 parent 6313c7d
commit 2edd8a2
Show file tree

Hide file tree

Showing 13 changed files with 40 additions and 37 deletions.
diff --git a/.github/workflows/build-docker-from-tag.yml b/.github/workflows/build-docker-from-tag.yml
@@ -103,7 +103,7 @@ jobs:
       image_tag_suffix: ${{ needs.setup.outputs.image_tag_suffix }}-avx512
       ERA_BELLMAN_CUDA_RELEASE: ${{ vars.ERA_BELLMAN_CUDA_RELEASE }}
       CUDA_ARCH: "60;70;75;80;89"
-      WITNESS_GENERATOR_RUST_FLAGS: "-Ctarget_feature=+avx512bw,+avx512cd,+avx512dq,+avx512f,+avx512vl --cfg=no_cuda"
+      WITNESS_GENERATOR_RUST_FLAGS: "-Ctarget_feature=+avx512bw,+avx512cd,+avx512dq,+avx512f,+avx512vl"
     secrets:
       DOCKERHUB_USER: ${{ secrets.DOCKERHUB_USER }}
       DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}

diff --git a/.github/workflows/build-witness-generator-template.yml b/.github/workflows/build-witness-generator-template.yml
@@ -51,6 +51,7 @@ jobs:
       ERA_BELLMAN_CUDA_RELEASE: ${{ inputs.ERA_BELLMAN_CUDA_RELEASE }}
       CUDA_ARCH: ${{ inputs.CUDA_ARCH }}
       WITNESS_GENERATOR_RUST_FLAGS: ${{ inputs.WITNESS_GENERATOR_RUST_FLAGS }}
+      ZKSYNC_USE_CUDA_STUBS: true
     runs-on: [ matterlabs-ci-runner-c3d ]
     strategy:
       matrix:

diff --git a/.github/workflows/ci-common-reusable.yml b/.github/workflows/ci-common-reusable.yml
@@ -22,7 +22,7 @@ jobs:
           echo "SCCACHE_GCS_SERVICE_ACCOUNT=gha-ci-runners@matterlabs-infra.iam.gserviceaccount.com" >> .env
           echo "SCCACHE_GCS_RW_MODE=READ_WRITE" >> .env
           echo "RUSTC_WRAPPER=sccache" >> .env
-          echo "RUSTFLAGS=--cfg=no_cuda" >> .env
+          echo "ZKSYNC_USE_CUDA_STUBS=true" >> .env
 
       - name: Start services
         run: |

diff --git a/.github/workflows/ci-core-lint-reusable.yml b/.github/workflows/ci-core-lint-reusable.yml
@@ -19,7 +19,7 @@ jobs:
           echo "SCCACHE_GCS_SERVICE_ACCOUNT=gha-ci-runners@matterlabs-infra.iam.gserviceaccount.com" >> .env
           echo "SCCACHE_GCS_RW_MODE=READ_WRITE" >> .env
           echo "RUSTC_WRAPPER=sccache" >> .env
-          echo "RUSTFLAGS=--cfg=no_cuda" >> .env
+          echo "ZKSYNC_USE_CUDA_STUBS=true" >> .env
           echo "prover_url=postgres://postgres:notsecurepassword@localhost:5432/zksync_local_prover" >> $GITHUB_ENV
           echo "core_url=postgres://postgres:notsecurepassword@localhost:5432/zksync_local" >> $GITHUB_ENV
 

diff --git a/.github/workflows/ci-prover-reusable.yml b/.github/workflows/ci-prover-reusable.yml
@@ -57,7 +57,7 @@ jobs:
           echo "SCCACHE_GCS_SERVICE_ACCOUNT=gha-ci-runners@matterlabs-infra.iam.gserviceaccount.com" >> .env
           echo "SCCACHE_GCS_RW_MODE=READ_WRITE" >> .env
           echo "RUSTC_WRAPPER=sccache" >> .env
-          echo "RUSTFLAGS=--cfg=no_cuda" >> .env
+          echo "ZKSYNC_USE_CUDA_STUBS=true" >> .env
 
       - name: Start services
         run: |

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -166,7 +166,7 @@ jobs:
     with:
       image_tag_suffix: ${{ needs.setup.outputs.image_tag_suffix }}-avx512
       action: "build"
-      WITNESS_GENERATOR_RUST_FLAGS: "-Ctarget_feature=+avx512bw,+avx512cd,+avx512dq,+avx512f,+avx512vl --cfg=no_cuda"
+      WITNESS_GENERATOR_RUST_FLAGS: "-Ctarget_feature=+avx512bw,+avx512cd,+avx512dq,+avx512f,+avx512vl"
     secrets:
       DOCKERHUB_USER: ${{ secrets.DOCKERHUB_USER }}
       DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}

diff --git a/.github/workflows/release-test-stage.yml b/.github/workflows/release-test-stage.yml
@@ -115,7 +115,7 @@ jobs:
       image_tag_suffix: ${{ needs.setup.outputs.image_tag_suffix }}-avx512
       ERA_BELLMAN_CUDA_RELEASE: ${{ vars.ERA_BELLMAN_CUDA_RELEASE }}
       CUDA_ARCH: "60;70;75;80;89"
-      WITNESS_GENERATOR_RUST_FLAGS: "-Ctarget_feature=+avx512bw,+avx512cd,+avx512dq,+avx512f,+avx512vl --cfg=no_cuda"
+      WITNESS_GENERATOR_RUST_FLAGS: "-Ctarget_feature=+avx512bw,+avx512cd,+avx512dq,+avx512f,+avx512vl "
     secrets:
       DOCKERHUB_USER: ${{ secrets.DOCKERHUB_USER }}
       DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}

diff --git a/docker/witness-generator/Dockerfile b/docker/witness-generator/Dockerfile
@@ -1,8 +1,9 @@
 FROM ghcr.io/matter-labs/zksync-build-base:latest AS builder
 
 ARG DEBIAN_FRONTEND=noninteractive
-ARG RUST_FLAGS="--cfg=no_cuda"
+ARG RUST_FLAGS=""
 ENV RUSTFLAGS=${RUST_FLAGS}
+ENV ZKSYNC_USE_CUDA_STUBS=true
 
 # set of args for use of sccache
 ARG SCCACHE_GCS_BUCKET=""

diff --git a/docker/witness-vector-generator/Dockerfile b/docker/witness-vector-generator/Dockerfile
@@ -1,8 +1,7 @@
 FROM ghcr.io/matter-labs/zksync-build-base:latest AS builder
 
 ARG DEBIAN_FRONTEND=noninteractive
-ARG RUST_FLAGS="--cfg=no_cuda"
-ENV RUSTFLAGS=${RUST_FLAGS}
+ENV ZKSYNC_USE_CUDA_STUBS=true
 
 # set of args for use of sccache
 ARG SCCACHE_GCS_BUCKET=""

diff --git a/docs/guides/external-node/00_quick_start.md b/docs/guides/external-node/00_quick_start.md
@@ -34,8 +34,7 @@ cd docker-compose-examples
 docker compose --file testnet-external-node-docker-compose.yml down --volumes
 ```
 
-You can see the status of the node (after recovery) in
-[local grafana dashboard](http://localhost:3000/dashboards).
+You can see the status of the node (after recovery) in [local grafana dashboard](http://localhost:3000/dashboards).
 
 Those commands start ZKsync node locally inside docker.
 

diff --git a/docs/guides/setup-dev.md b/docs/guides/setup-dev.md
@@ -49,9 +49,9 @@ cargo install sqlx-cli --version 0.8.1
 curl -L https://foundry.paradigm.xyz | bash
 foundryup --branch master
 
-# Non GPU setup, can be skipped if the machine has a GPU configured for provers
-echo "export RUSTFLAGS='--cfg=no_cuda'" >> ~/.bashrc
-
+# Non CUDA (GPU) setup, can be skipped if the machine has a CUDA installed for provers
+# Don't do that if you intend to run provers on your machine. Check the prover docs for a setup instead.
+echo "export ZKSYNC_USE_CUDA_STUBS=true" >> ~/.bashrc
 # You will need to reload your `*rc` file here
 
 # Clone the repo to the desired location
@@ -243,20 +243,23 @@ commands related to deployment, you can pass flags for Foundry integration.
 
 ## Non-GPU setup
 
-Circuit Prover requires a GPU (& CUDA bindings) to run. If you still want to be able to build everything locally on
-non-GPU setup, you'll need to change your rustflags.
+Circuit Prover requires a CUDA bindings to run. If you still want to be able to build everything locally on non-CUDA
+setup, you'll need use CUDA stubs.
 
 For a single run, it's enough to export it on the shell:
 
 ```
-export RUSTFLAGS='--cfg=no_cuda'
+export ZKSYNC_USE_CUDA_STUBS=true
 ```
 
-For persistent runs, you can either echo it in your ~/.<shell>rc file (discouraged), or configure it for your taste in
-`config.toml`.
+For persistent runs, you can echo it in your ~/.<shell>rc file
+
+```
+echo "export ZKSYNC_USE_CUDA_STUBS=true" >> ~/.<SHELL>rc
+```
 
-For project level configuration, edit `/path/to/zksync/.cargo/config.toml`. For global cargo setup,
-`~/.cargo/config.toml`. Add the following:
+Note that the same can be achieved with RUSTFLAGS (discouraged). The flag is `--cfg=no_cuda`. You can either set
+RUSTFLAGS as env var, or pass it in `config.toml` (either project level or global). The config would need the following:
 
 ```toml
 [build]

diff --git a/prover/Cargo.lock b/prover/Cargo.lock
diff --git a/prover/Cargo.toml b/prover/Cargo.toml
@@ -63,8 +63,8 @@ circuit_sequencer_api = "=0.150.5"
 zkevm_test_harness = "=0.150.5"
 
 # GPU proving dependencies
-wrapper_prover = { package = "zksync-wrapper-prover", version = "=0.150.7" }
-shivini = "=0.150.7"
+wrapper_prover = { package = "zksync-wrapper-prover", version = "=0.150.9" }
+shivini = "=0.150.9"
 
 # Core workspace dependencies
 zksync_multivm = { path = "../core/lib/multivm", version = "0.1.0" }