👷 Track Rust performance benchmarks on CI (#61)

* ⬆️ Bump criterion from 0.5.1 to 0.7.0

Bumps [criterion](https://github.com/bheisler/criterion.rs) from 0.5.1 to 0.7.0.
- [Changelog](https://github.com/bheisler/criterion.rs/blob/master/CHANGELOG.md)
- [Commits](bheisler/criterion.rs@0.5.1...0.7.0)

No need to use the criterion.rs fork set at f07ae72/#27, because the original error `assertion failed: slice.len() > 1 && slice.iter().all(|x| !x.is_nan())` can been fixed by setting nresamples to 2, yeah I know right!

* 👷 Run criterion benchmarks on CI with cargo-codspeed

Use codspeed-criterion-compat crate inplace of criterion, and setup CI job to run the Rust benchmarks!

* 💚 Run on ghcr.io/osgeo/gdal:ubuntu-small-3.11.5 container

And bump to georust/gdal version with GDAL 3.11 bindings.

* 🚨 Set git config core.longpaths to true

Fix `failed to update submodule `gdal-src/source` ... Caused by: path too long: 'C:/Users/runneradmin/.cargo/git/checkouts/gdal-3b51095beae5b4fc/3df2c28/gdal-src/source/...`.

* 💚 Cargo remove gdal-src and gdal-sys in benchmark tests

Fix `undefined reference to `GDALGetRasterBand'` and various other linker errors. Just rely on existing GDAL installation within the docker container, rather than the pre-built bindings.

* ⚗️ Benchmark with LiberTIFF driver

Benchmark reading with GDAL 3.11's LiberTIFF driver, using 4 threads. Also renumbered the benchmark IDs to start from 0.

* 🥚 Do host to device copy when 'cuda' flag is enabled

Ensure fair comparison between nvTIFF which reads to CUDA memory (even though it's the fastest already), and the GDAL LiberTIFF and image-tiff backend readers.

Author: weiji14

.github/workflows/benchmarks.yml

@@ -1,7 +1,7 @@
 # Run performance benchmarks
 #
-# Continuous benchmarking using pytest-codspeed. Measures the execution speed
-# of tests marked with @pytest.mark.benchmark decorator.
+# Continuous benchmarking with CodSpeed. Measures the execution speed of Rust benchmarks
+# via cargo-codspeed, and Python tests marked with @pytest.mark.benchmark decorator.
 
 name: Benchmarks
 
@@ -16,10 +16,56 @@ on:
   # performance analysis in order to generate initial data.
   workflow_dispatch:
 
+env:
+  CARGO_TERM_COLOR: always
+
 permissions: {}
 
 jobs:
-  benchmarks:
+  rust-benchmarks:
+    name: "Run Rust benchmarks"
+    runs-on: ubuntu-24.04
+    container:
+      image: ghcr.io/osgeo/gdal:ubuntu-small-3.11.5
+      options: --privileged
+    steps:
+      - name: Install dev dependencies and setup git
+        run: |
+          apt update
+          apt install -y build-essential cmake git libclang-dev pkg-config
+          git config --global --add safe.directory $GITHUB_WORKSPACE
+
+      - name: Checkout repository
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          persist-credentials: false
+
+      - name: Download sample GeoTIFF
+        run: |
+          curl --create-dir --remote-name --output-dir benches https://sentinel-cogs.s3.us-west-2.amazonaws.com/sentinel-s2-l2a-cogs/37/M/BV/2024/10/S2A_37MBV_20241029_0_L2A/TCI.tif
+          ls -lh benches/
+
+      - name: Setup rust toolchain, cache and cargo-codspeed binary
+        uses: moonrepo/setup-rust@ede6de059f8046a5e236c94046823e2af11ca670 # v1.2.2
+        with:
+          channel: 1.85.0 # msrv
+          cache: false
+          cache-target: release
+          bins: cargo-codspeed
+
+      - name: Build the benchmark target(s)
+        run: |
+          cargo remove --dev gdal-src gdal-sys
+          cargo codspeed build
+
+      - name: Run the benchmarks
+        uses: CodSpeedHQ/action@6a8e2b874c338bf81cc5e8be715ada75908d3871 # v4.3.4
+        with:
+          mode: instrumentation
+          run: cargo codspeed run
+
+  python-benchmarks:
+    name: "Run Python benchmarks"
     runs-on: ubuntu-24.04
     defaults:
       run:
@@ -28,7 +74,7 @@ jobs:
     steps:
       # Checkout current git repository
       - name: Checkout
-        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           persist-credentials: false
 
@@ -55,7 +101,7 @@ jobs:
 
       # Run the benchmark tests
       - name: Run benchmarks
-        uses: CodSpeedHQ/action@0010eb0ca6e89b80c88e8edaaa07cfe5f3e6664d # v3.5.0
+        uses: CodSpeedHQ/action@6a8e2b874c338bf81cc5e8be715ada75908d3871 # v4.3.4
         with:
-          run: |
-            python -m pytest --verbose --codspeed
+          mode: instrumentation
+          run: python -m pytest --verbose --codspeed

.github/workflows/ci.yml

@@ -134,6 +134,9 @@ jobs:
           python-version: "3.12"
           architecture: ${{ matrix.target }}
 
+      - name: Support longpaths
+        run: git config --system core.longpaths true
+
       - name: Build wheels
         uses: PyO3/maturin-action@aef21716ff3dcae8a1c301d23ec3e4446972a6e3 # v1.49.1
         with: