chore: custom cargo config to reduce build time

.cargo/config.toml

@@ -0,0 +1,30 @@
+[alias]
+b = "build"
+c = "check"
+d = "doc"
+t = "test"
+r = "run"
+
+[build]
+incremental = true
+# might be helpful but we don't enforce sccache installation atm
+# https://github.com/mozilla/sccache
+# rustc-wrapper = "sccache"
+
+# For details checkout https://jondot.medium.com/8-steps-for-troubleshooting-your-rust-build-times-2ffc965fd13e
+[target.x86_64-unknown-linux-gnu]
+# clang has been listed as prerequisite in the doc
+linker = "clang"
+# enable avx2 by default since it's avaiable on almost all x86_64 CPUs
+rustflags = ["-Clink-arg=-fuse-ld=lld", "-Ctarget-feature=+avx2,+fma", "-Zshare-generics=y"]
+
+[target.x86_64-apple-darwin]
+# zld might help here
+# brew install michaeleisel/zld/zld
+# "-Clink-arg=-fuse-ld=zld"
+# For details checkout https://jondot.medium.com/8-steps-for-troubleshooting-your-rust-build-times-2ffc965fd13e
+rustflags = ["-Ctarget-feature=+avx2,+fma", "-Zshare-generics=y"]
+
+[net]
+git-fetch-with-cli = true
+retry              = 5

.github/workflows/coverage.yml

@@ -11,22 +11,25 @@ jobs:
     runs-on: buildjet-8vcpu-ubuntu-2004
     timeout-minutes: 30
     steps:
-      - name: Install Dependencies
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y build-essential clang ocl-icd-opencl-dev
       - name: Checkout Sources
         uses: actions/checkout@v3
         with:
           submodules: true
-      - name: Rust Cache
-        uses: Swatinem/rust-cache@v2
-        timeout-minutes: 5
-        continue-on-error: true
+      - name: Apt Dependencies
+        run: sudo make install-deps
+      - name: Setup sccache
+        uses: hanabi1224/sccache-action@v1.2.0
+        with:
+          release-name: v0.3.0
+          cache-key: ${{ runner.os }}-sccache-codecov-${{ hashFiles('rust-toolchain.toml') }}
+          cache-update: ${{ github.event_name != 'pull_request' }}
       - name: Run cargo-llvm-cov
         uses: taiki-e/install-action@cargo-llvm-cov
       - name: Generate code coverage
         run: cargo llvm-cov --workspace --lcov --output-path lcov.info
+        env:
+          CC: "sccache clang"
+          CXX: "sccache clang++"
       - name: Upload CodeCov
         uses: codecov/codecov-action@v3
         with:

.github/workflows/docs.yml

@@ -17,28 +17,44 @@ jobs:
     name: Publish
     runs-on: ubuntu-latest
     steps:
-      - name: Apt Dependencies
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y build-essential clang ocl-icd-opencl-dev
       - name: Checkout Sources
         uses: actions/checkout@v3
+      - name: Apt Dependencies
+        run: sudo make install-deps
       - name: Link Checker (Repo)
         uses: lycheeverse/lychee-action@v1.5.1
         with:
           args: --verbose --no-progress 'README.md'
           # Fail action on broken links
           fail: true
-      - name: Rust Cache
-        uses: Swatinem/rust-cache@v2
-        timeout-minutes: 5
-        continue-on-error: true
+      - uses: actions/cache@v3
+        with:
+          path: |
+            ~/.cargo/bin/
+          key: ${{ runner.os }}-docs-cargo-bin-${{ hashFiles('rust-toolchain.toml') }}
       - name: Install MDBook
         run: cargo install mdbook mdbook-linkcheck --locked
+        env:
+          RUSTFLAGS: "-Cstrip=symbols"
+        continue-on-error: true
+      - name: Setup sccache
+        uses: hanabi1224/sccache-action@v1.2.0
+        with:
+          release-name: v0.3.0
+          cache-key: ${{ runner.os }}-sccache-docs-${{ hashFiles('rust-toolchain.toml') }}
+          # true: always save cache
+          # false: only save when cache is not found
+          # this option is only available in the forked action
+          # the original action has no activities for years so we
+          # just keep using the fork
+          cache-update: ${{ github.event_name != 'pull_request' }}
       - name: Execute MDBook
         run: make mdbook-build
       - name: Build rustdoc
         run: make rustdoc
+        env:
+          CC: "sccache clang"
+          CXX: "sccache clang++"
       - name: Link Checker (Docs)
         uses: lycheeverse/lychee-action@v1.5.1
         with:

.github/workflows/release.yml

@@ -17,17 +17,15 @@ jobs:
           - os: macos-latest
             file: forest-${{ github.ref_name }}-macos-amd64.zip
     steps:
+      - name: Checkout Sources
+        uses: actions/checkout@v3
       - name: Apt Dependencies
         if: startsWith(matrix.os, 'Ubuntu')
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y build-essential clang ocl-icd-opencl-dev
+        run: sudo make install-deps
       - name: Homebrew Utils
         if: startsWith(matrix.os, 'macOS')
         run: |
           brew install --verbose coreutils
-      - name: Checkout Sources
-        uses: actions/checkout@v3
       - name: Rust Cache
         uses: Swatinem/rust-cache@v2
         timeout-minutes: 5

.github/workflows/rust.yml

@@ -1,6 +1,7 @@
 name: Rust
 
 on:
+  workflow_dispatch:
   pull_request:
     branches:
       - main
@@ -14,140 +15,112 @@ env:
   CI: 1
   CARGO_INCREMENTAL: 1
   CACHE_TIMEOUT_MINUTES: 5
-  RUSTFLAGS: -Ctarget-feature=+avx2,+fma
 
 jobs:
   test:
     name: Test
     runs-on: buildjet-8vcpu-ubuntu-2004
     timeout-minutes: 30
-    env:
-      RUSTFLAGS: "-Ctarget-feature=+avx2,+fma -D warnings"
     steps:
-      - name: Install Dependencies
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y build-essential clang ocl-icd-opencl-dev
       - name: Checkout Sources
         uses: actions/checkout@v3
+      - name: Setup sccache
+        uses: hanabi1224/sccache-action@v1.2.0
+        with:
+          release-name: v0.3.0
+          cache-key: ${{ runner.os }}-sccache-test-${{ hashFiles('rust-toolchain.toml') }}
+          cache-update: ${{ github.event_name != 'pull_request' }}
+      - name: Apt Dependencies
+        run: sudo make install-deps
       - name: install nextest
         uses: taiki-e/install-action@nextest
-      - name: Rust Cache
-        uses: Swatinem/rust-cache@v2
-        timeout-minutes: ${{ fromJSON(env.CACHE_TIMEOUT_MINUTES) }}
-        continue-on-error: true
-      - name: Cargo Check
-        run: cargo check
-      - name: Make Test-All
-        run: make test-all
-
-  lint:
-    name: Lint
-    runs-on: ubuntu-latest
-    steps:
-      - name: Apt Dependencies
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y build-essential clang ocl-icd-opencl-dev
-      - name: Checkout Sources
-        uses: actions/checkout@v3
-      - name: Rust Cache
-        uses: Swatinem/rust-cache@v2
-        timeout-minutes: ${{ fromJSON(env.CACHE_TIMEOUT_MINUTES) }}
-        continue-on-error: true
-      - name: Install taplo (TOML linter)
-        run: cargo install taplo-cli --locked
-      - name: Run Linters
-        run: make lint
-
-  audit:
-    name: Audit
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Sources
-        uses: actions/checkout@v3
-      - name: Rust Cache
-        uses: Swatinem/rust-cache@v2
-        timeout-minutes: ${{ fromJSON(env.CACHE_TIMEOUT_MINUTES) }}
-        continue-on-error: true
-      - name: Install Audit
-        run: cargo install cargo-audit --locked
-      - name: Run Audit
-        run: make audit
-
-  unused_dependencies:
-    name: Unused dependencies
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Sources
-        uses: actions/checkout@v3
-      - name: Rust Cache
-        uses: Swatinem/rust-cache@v2
-        timeout-minutes: ${{ fromJSON(env.CACHE_TIMEOUT_MINUTES) }}
-        continue-on-error: true
-      - name: Install udeps
-        run: cargo install cargo-udeps --locked
-      - name: Run udeps
-        run: make udeps
+      - run: make test-all
+        env:
+          CC: "sccache clang"
+          CXX: "sccache clang++"
 
-  spellcheck:
-    name: Spellcheck
+  lint-all:
+    name: All lint checks (lint audit spellcheck udeps)
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Sources
         uses: actions/checkout@v3
-      - name: Rust Cache
-        uses: Swatinem/rust-cache@v2
-        timeout-minutes: ${{ fromJSON(env.CACHE_TIMEOUT_MINUTES) }}
+      - name: Apt Dependencies
+        run: sudo make install-deps
+      - uses: actions/cache@v3
+        with:
+          path: |
+            ~/.cargo/bin/
+          key: ${{ runner.os }}-lints-cargo-bin-${{ hashFiles('rust-toolchain.toml') }}
+      - run: make install-lint-tools
         continue-on-error: true
-      - name: Install spellcheck
-        run: cargo install cargo-spellcheck --locked
-      - name: Run Spellcheck
-        run: make spellcheck
+      - name: Setup sccache
+        uses: hanabi1224/sccache-action@v1.2.0
+        with:
+          release-name: v0.3.0
+          cache-key: ${{ runner.os }}-sccache-lints-${{ hashFiles('rust-toolchain.toml') }}
+          cache-update: ${{ github.event_name != 'pull_request' }}
+      - run: make lint-all
+        env:
+          CC: "sccache clang"
+          CXX: "sccache clang++"
 
   build:
     name: Build
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest]
-        #rv: [1.58.1, stable, beta, nightly]
-        rv: [nightly]
     steps:
-      - name: Install Dependencies
-        if: startsWith(matrix.os, 'Ubuntu')
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y build-essential clang ocl-icd-opencl-dev
       - name: Checkout Sources
         uses: actions/checkout@v3
-      - name: Rust Cache
-        uses: Swatinem/rust-cache@v2
-        timeout-minutes: ${{ fromJSON(env.CACHE_TIMEOUT_MINUTES) }}
-        continue-on-error: true
-      - name: Cargo Build
-        run: cargo build --profile dev
+      - name: Setup sccache
+        uses: hanabi1224/sccache-action@v1.2.0
+        with:
+          # hard code release-name for macos, it always get rate limited when calling github api
+          release-name: v0.3.0
+          cache-key: ${{ runner.os }}-sccache-${{ hashFiles('rust-toolchain.toml') }}
+          cache-update: ${{ github.event_name != 'pull_request' }}
+      - name: Install Apt Dependencies
+        if: startsWith(matrix.os, 'Ubuntu')
+        run: |
+          lscpu # the job may run on different CPUs, list cpu here for analysing build time
+          sudo make install-deps
+      - name: Cargo Check
+        run: cargo check --timings
+        env:
+          CC: "sccache clang"
+          CXX: "sccache clang++"
+      - uses: actions/upload-artifact@v3
+        with:
+          name: build-timings
+          path: |
+            target/cargo-timings/*
+          if-no-files-found: error
 
   calibnet-check:
     name: Calibnet sync check
     if: ${{ false }}
     runs-on: buildjet-8vcpu-ubuntu-2004
     timeout-minutes: 30
     steps:
-      - name: Install Dependencies
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y build-essential clang ocl-icd-opencl-dev
       - name: Checkout Sources
         uses: actions/checkout@v3
         with:
           submodules: true
-      - name: Rust Cache
-        uses: Swatinem/rust-cache@v2
-        timeout-minutes: ${{ fromJSON(env.CACHE_TIMEOUT_MINUTES) }}
-        continue-on-error: true
+      - name: Apt Dependencies
+        run: sudo make install-deps
+      - name: Setup sccache
+        uses: hanabi1224/sccache-action@v1.2.0
+        with:
+          release-name: v0.3.0
+          cache-key: ${{ runner.os }}-sccache-calibnet-check-${{ hashFiles('rust-toolchain.toml') }}
+          cache-update: ${{ github.event_name != 'pull_request' }}
       - name: build and install binaries
         run: make install
+        env:
+          CC: "sccache clang"
+          CXX: "sccache clang++"
       - name: download snapshot
         run: forest-cli --chain calibnet chain fetch -s /tmp/snapshots/
       - name: import snapshot and run Forest

.gitignore

@@ -9,6 +9,7 @@ config*.toml
 *.orig
 criterion
 genesis.json
-/.cargo
+/.cargo/*
+!/.cargo/*.toml
 node/rpc-api/static/ast.ron
 documentation/book/**/*

Dockerfile

@@ -20,14 +20,13 @@
 FROM buildpack-deps:buster AS build-env
 
 # Install dependencies
-RUN apt-get update && apt-get install --no-install-recommends -y build-essential clang ocl-icd-opencl-dev cmake ca-certificates curl
+RUN apt-get update && apt-get install --no-install-recommends -y build-essential clang lld ocl-icd-opencl-dev cmake ca-certificates curl
 RUN update-ca-certificates
 
 # Install rustup
 # https://rustup.rs/
 RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
 ENV PATH="/root/.cargo/bin:${PATH}"
-ENV RUSTFLAGS="-Ctarget-feature=+avx2,+fma"
 
 WORKDIR /usr/src/forest
 COPY . .