Compare commits

...
62 Commits
Author SHA1 Message Date
noah d7ae81dce9 Merge pull request 'ci: restore Toolkit main release to Alkane build pool' (#5) from ci/restore-main-release-pool into main 2026-10-19 06:30:16 -06:00
noah 10c93a3246 ci: route full Toolkit main release to Alkane build pool 2026-10-19 06:18:28 -06:00
noah 50ff6c60ce Merge pull request 'Use persistent Alkane cache for Toolkit main releases' (#4) from ci/static-main-release into main 2026-10-19 05:11:16 -06:00
noah cfe1f5be3b Run Toolkit main release on persistent Alkane verifier 2026-10-19 04:13:38 -06:00
noah 22e9106606 Merge pull request 'Use bounded Rust cache in Toolkit main and next CI' (#3) from ci/cache-main-and-next into main
Use bounded Rust cache on Toolkit main and next
2026-10-19 00:04:50 -06:00
noah c6b67c3b86 Bound Toolkit release compiler parallelism to measured memory 2026-10-18 23:53:33 -06:00
noah 77aacef528 Use bounded Rust cache in Toolkit main and next CI 2026-10-18 23:51:54 -06:00
noah 9bab162d64 Merge pull request 'Scope Toolkit PR checks and use prebuilt CI tools' (#2) from ci/docs-pr-fast-path into main
Speed Toolkit CI with scoped PR checks and bounded compiler caching
2026-10-18 23:49:27 -06:00
noah d0bbed568c Pilot bounded Rust compiler cache in Toolkit verification 2026-10-18 23:01:58 -06:00
noah 41142e707a Avoid duplicate source job for Toolkit main PRs 2026-10-18 22:35:04 -06:00
noah 7f106e2deb Use prebuilt CI tools and skip redundant wx cache transfer 2026-10-18 22:28:35 -06:00
noah 5cdce25329 Skip wx cache upload when image supplies the library 2026-10-18 22:15:27 -06:00
noah 01dd9ca287 Reject symlinked wx prefix markers 2026-10-18 22:02:48 -06:00
noah cb4c56679d Verify wx source provenance before reusing prefix 2026-10-18 21:56:00 -06:00
noah d0ecaea174 Publish Toolkit benchmarks on Pages runner after main CI 2026-10-18 21:50:25 -06:00
noah a77cd3a682 Include every Toolkit crate in unit coverage 2026-10-18 21:31:36 -06:00
noah c3efda87c3 Cover all Toolkit crates and pin CI image 2026-10-18 21:29:33 -06:00
noah afbaac0c0e Scope headless crate PR checks to reverse dependencies 2026-10-18 21:04:36 -06:00
noah c287aaaf58 Save wxWidgets cache before later quality checks 2026-10-18 21:04:35 -06:00
noah 6e09624120 Key wxWidgets cache to available native packages 2026-10-18 21:04:33 -06:00
noah 1edc446940 Skip redundant Toolkit package setup on prepared runners 2026-10-18 21:04:32 -06:00
noah f86f34bd90 Skip heavyweight Toolkit checks for documentation-only PRs 2026-10-18 21:04:30 -06:00
noah ff0724f96a Merge pull request 'Consolidate Toolkit CI setup and gate benchmark publication' (#1) from ci/release-setup-pages-order into main 2026-10-18 21:02:52 -06:00
noah 41d2bd6d91 Key wxWidgets cache to source and toolchain inputs 2026-10-18 20:15:24 -06:00
noah 8a75ee40bc Isolate Toolkit pull request verification from release queue 2026-10-18 20:13:17 -06:00
noah 75be20163d Stop scheduled Toolkit benchmark republishing 2026-10-18 20:03:45 -06:00
noah 0013dd45c2 Separate fast Toolkit checks from full main verification 2026-10-18 20:01:37 -06:00
noah a3ee239900 Route short Toolkit checks to Alkane fast runner 2026-10-18 20:01:35 -06:00
noah 5fc08e408e Use lightweight checks for Toolkit feature and next changes 2026-10-18 20:01:32 -06:00
noah 5098be30d1 Consolidate setup and gate benchmark publication 2026-10-18 20:01:26 -06:00
noah 1323dc1571 Add bounded read-only SSH board probes 2026-10-17 08:00:36 -06:00
noah 848a78ed5f docs: shorten Toolkit entry guide 2026-10-17 01:42:12 -06:00
noah 8d092ae417 Publish Toolkit benchmarks on the standing Alkane runner 2026-10-17 01:21:21 -06:00
noah 7445b05e57 Validate public benchmark page before upload 2026-10-16 08:46:06 -06:00
noah faae4ee145 Publish Toolkit benchmarks to public Pages site 2026-10-16 07:19:42 -06:00
noah 942801ee4b Bound queued Toolkit CI attempts per branch 2026-10-16 07:08:39 -06:00
noah 8de1bdffd4 Average benchmark improvements equally in Toolkit badge 2026-10-16 06:02:42 -06:00
noah 77237023e3 Require complete Toolkit benchmarks before release 2026-10-16 05:11:44 -06:00
noah fc573f075a Benchmark health diagnostics on representative miners 2026-10-15 20:19:18 -06:00
noah 1c364d4ff1 Guard UTF-8 naming and repair headless screenshots 2026-10-15 20:10:19 -06:00
noah d54bd6473f Stage verified flash images before device writes 2026-10-15 19:10:28 -06:00
noah a5b07d22ae Grade Toolkit code quality from static checks 2026-10-15 19:03:34 -06:00
Noah 3d17326460 Simplify Toolkit docs and update installer status 2026-10-15 14:36:09 -06:00
noah 56339a5eca Clean candidate build after prerelease decision 2026-10-15 12:43:30 -06:00
noah 00bb760451 Clean generated Toolkit builds after CI and local GUI builds 2026-10-15 11:51:55 -06:00
noah 5f472435a7 Parse Rust test harness benchmark output 2026-10-15 04:06:32 -06:00
noah f22fe19a4d Compare toolkit benchmarks on matching CPU classes 2026-10-15 03:36:53 -06:00
noah 8ab83edc73 Derive toolkit quality grade from measured coverage 2026-10-15 03:34:11 -06:00
noah 601da0548b Revalidate artifacts and guard complete flash streams 2026-10-14 20:54:29 -06:00
noah 4592b927ad Use Gitea-compatible pinned artifact upload 2026-10-14 20:51:23 -06:00
noah 5e347315e2 Publish measured toolkit badges from main CI 2026-10-14 20:44:35 -06:00
noah 603c49a395 Guard verified artifact writes with recovery checks 2026-10-14 20:40:22 -06:00
noah bc8e0535d1 Verify toolkit firmware artifacts before install 2026-10-14 20:31:04 -06:00
noah cf1eaebae1 Record private toolkit benchmark history 2026-10-14 20:21:19 -06:00
noah f89f220f3e Standardize toolkit CI badges and scoped release auth 2026-10-14 20:05:49 -06:00
alkane-ci c18a37eebc ci: refresh README badges [skip release] 2026-10-13 23:27:22 +00:00
noah d3a06d682f Read benchmark coverage from release objects 2026-10-13 12:09:59 -06:00
noah 4d530721dc Trim CI script trailing blank lines 2026-10-13 11:54:00 -06:00
noah 0b691ca943 Add next release candidates and main branch gates 2026-10-13 11:53:22 -06:00
alkane-ci ed0f781851 ci: refresh README badges [skip release] 2026-10-02 16:16:14 +00:00
noahandClaude Opus 4.8 613132035a feat(gui,asic-rs): hashboard yellow-not-red, power-limit column, chip/HB/PSU-serial coverage
Round 21 (three reported items).

1. A hashboard that is still mining near full hashrate but has some failed chips
   now shows yellow (degraded), not red. VNish emits per-board chip failures as
   Warning while the board is mining (Error only when the board is not mining),
   and board_healths() renders a warning-only board as Degraded instead of Down.
   Verified live on 10.4.0.193 (mining ~83%, dead chips -> yellow).

2. New "Power limit" column: the configured power-target setpoint in watts
   (MinerRow.power_limit_w, from a Power tuning target). WhatsMiner shows its
   "Power Limit" (e.g. 2500 W); the value was already scanned but had no dedicated
   column. Numeric (sortable/filterable), Performance category, opt-in.

3. Chip + hashboard model coverage:
   - VNish hashboard model scanned from factory-info board_model (A3HB70601,
     BHB42603, ...) -- 147-unit fleet gains HB model. Both VNish backends.
   - WhatsMiner v1/v2 PSU serial scanned from get_psu serial_no (was hardcoded
     None). 48-unit fleet gains PSU serial.
   - Chip type derived from the detected model for Antminer hardware (VNish/stock/
     LuxOS/Braiins/UMC never report a chip string on the wire), in naming.rs:
     S21Pro->BM1370, S19jPro->BM1362, S19KPro->BM1366, S19/T19->BM1398, etc.
     Only high-confidence mappings; WhatsMiner and unknown models stay blank.
   PSU Vmin/Vmax remain Braiins/ePIC-only (not on the wire for WhatsMiner/VNish/
   Antminer -- confirmed live).

asic-rs patch 0033. 95 unit tests pass.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-10-02 10:09:07 -06:00
alkane-ci b3dc5a336e ci: refresh README badges [skip release] 2026-09-24 21:33:46 +00:00
67 changed files with 3444 additions and 459 deletions
+33
View File
@@ -0,0 +1,33 @@
name: public-benchmark-pages
on:
workflow_run:
workflows: [build-test-release]
types: [completed]
workflow_dispatch:
concurrency:
group: alkane-toolkit-public-benchmark-pages
cancel-in-progress: false
jobs:
publish:
runs-on: alkane-pages
permissions:
contents: read
steps:
- uses: actions/checkout@v4
- name: Install SSH client
run: bash ci/ensure-build-deps.sh ssh
- name: Render measured benchmark history
env:
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
run: python3 ci/bench_history.py render
- name: Publish public benchmark page
env:
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
BENCH_PAGES_DEPLOY_KEY: ${{ secrets.BENCH_PAGES_DEPLOY_KEY }}
run: python3 ci/publish-bench-pages.py toolkit
- name: Clean generated page
if: always()
run: python3 ci/cleanup-generated.py
+21
View File
@@ -0,0 +1,21 @@
name: completed-ci-badge
on:
workflow_run:
workflows: [build-test-release, next-build]
types: [completed]
jobs:
publish:
runs-on: alkane-fast
container:
image: gitea.bluefla.re/blueflare/alkane-ci@sha256:9d2a992bbcb91014af3c85d2e1ec8c5990701cecf83fd06c8d46f9ef13dbd948
permissions:
actions: read
contents: write
steps:
- uses: actions/checkout@v4
- name: Publish last completed attempt
env:
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
run: python3 ci/last-attempt-badge.py
+81
View File
@@ -0,0 +1,81 @@
name: next-build
on:
push:
branches: [next]
concurrency:
group: alkane-toolkit-next
cancel-in-progress: false
permissions:
contents: write
jobs:
candidate:
runs-on: alkane-ci
container:
image: gitea.bluefla.re/blueflare/alkane-ci@sha256:9d2a992bbcb91014af3c85d2e1ec8c5990701cecf83fd06c8d46f9ef13dbd948
env:
CARGO_TARGET_DIR: target
CARGO_BUILD_JOBS: 2
WX_PREFIX: /root/.cache/wx-3.3.3-linux
WX_RS_WXCONFIG: /root/.cache/wx-3.3.3-linux/bin/wx-config
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Check runner image pins
run: python3 ci/check-runner-image.py
- name: Install build dependencies
run: bash ci/ensure-build-deps.sh base
- name: Configure bounded Rust compiler cache
run: bash ci/configure-rust-cache.sh
- name: Compute wxWidgets cache key
id: wx-key
run: bash ci/wx-cache-key.sh
- name: Check prebuilt wxWidgets
id: wx-image
run: bash ci/check-wx-image-prefix.sh
- id: wx-cache
if: steps.wx-image.outputs.available != 'true'
uses: actions/cache/restore@v4
continue-on-error: true
with:
path: /root/.cache/wx-3.3.3-linux
key: ${{ steps.wx-key.outputs.key }}
- name: Build wxWidgets
id: wx-build
run: bash ci/ensure-wx-prefix.sh
- name: Save vendored wxWidgets build
if: steps.wx-cache.outputs.cache-hit != 'true' && steps.wx-build.outputs.built == 'true'
uses: actions/cache/save@v4
continue-on-error: true
with:
path: /root/.cache/wx-3.3.3-linux
key: ${{ steps.wx-key.outputs.key }}
- name: Build release candidate
run: cargo build --release -p alkane-gui -p alkane-artifacts -p alkane-flash -p alkane-cli --offline
- name: Select candidate version
id: version
run: bash ci/compute-rc-version.sh >> "$GITHUB_OUTPUT"
- name: Package candidate
if: steps.version.outputs.release == 'true'
run: |
mkdir -p dist
cp target/release/alkane-toolkit dist/
tar -C dist -czf "dist/alkane-toolkit-${{ steps.version.outputs.version }}-linux-x86_64.tar.gz" alkane-toolkit
- name: Create private prerelease
if: steps.version.outputs.release == 'true'
env:
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
run: python3 ci/release-rc.py "${{ steps.version.outputs.tag }}" true "dist/alkane-toolkit-${{ steps.version.outputs.version }}-linux-x86_64.tar.gz"
- name: Rust compiler cache statistics
if: always()
run: |
if [ -n "${SCCACHE_DIR:-}" ]; then
sccache --show-stats
fi
- name: Clean generated Toolkit build
if: always()
run: python3 ci/cleanup-generated.py
+124 -110
View File
@@ -6,10 +6,22 @@ on:
push:
branches: [main]
concurrency:
group: alkane-toolkit-main
cancel-in-progress: false
permissions:
contents: write
actions: write
jobs:
release:
runs-on: alkane-ci
container:
image: gitea.bluefla.re/blueflare/alkane-ci@sha256:9d2a992bbcb91014af3c85d2e1ec8c5990701cecf83fd06c8d46f9ef13dbd948
env:
CARGO_TARGET_DIR: target
CARGO_BUILD_JOBS: 2
WX_PREFIX: /root/.cache/wx-3.3.3-linux
# Set once for the whole job so build/clippy/test/bench steps don't each
# re-export it (round 18 #12).
@@ -20,43 +32,65 @@ jobs:
with:
fetch-depth: 0
- name: Check runner image pins
run: python3 ci/check-runner-image.py
- name: Compute version
id: ver
run: bash ci/compute-version.sh | tee -a "$GITHUB_OUTPUT"
- name: Test version logic
if: steps.ver.outputs.release == 'true'
run: bash ci/test-compute-version.sh
- name: Last-attempt badge checks
run: python3 ci/test-last-attempt-badge.py
- name: Benchmark history checks
run: python3 ci/test-bench-history.py
- name: Benchmark suite checks
run: python3 ci/test-bench-badge.py
- name: Install build dependencies
if: steps.ver.outputs.release == 'true'
run: |
apt-get update -qq
apt-get install -y -qq --no-install-recommends \
libssl-dev pkg-config ca-certificates >/dev/null
echo "libssl-dev + pkg-config installed (openssl-sys needs them)"
run: bash ci/ensure-build-deps.sh all
- name: Configure bounded Rust compiler cache
run: bash ci/configure-rust-cache.sh
- name: Compute wxWidgets cache key
id: wx-key
run: bash ci/wx-cache-key.sh
- name: Check prebuilt wxWidgets
id: wx-image
run: bash ci/check-wx-image-prefix.sh
- name: Cache vendored wxWidgets build
if: steps.ver.outputs.release == 'true'
uses: actions/cache@v4
if: steps.wx-image.outputs.available != 'true'
id: wx-cache
uses: actions/cache/restore@v4
continue-on-error: true
with:
path: /root/.cache/wx-3.3.3-linux
key: wx-3.3.3-${{ runner.os }}-${{ hashFiles('thirdparty/wx-rs/VERSION') }}
key: ${{ steps.wx-key.outputs.key }}
- name: Build wxWidgets (once, then cached)
if: steps.ver.outputs.release == 'true'
run: |
if [ ! -x "$WX_PREFIX/bin/wx-config" ]; then
bash scripts/build-wx-linux.sh
else
echo "wx prefix restored from cache"
fi
id: wx-build
run: bash ci/ensure-wx-prefix.sh
- name: Save vendored wxWidgets build
if: steps.wx-cache.outputs.cache-hit != 'true' && steps.wx-build.outputs.built == 'true'
uses: actions/cache/save@v4
continue-on-error: true
with:
path: /root/.cache/wx-3.3.3-linux
key: ${{ steps.wx-key.outputs.key }}
- name: Clippy (our crate, warnings are errors)
if: steps.ver.outputs.release == 'true'
run: |
rustup component add clippy >/dev/null 2>&1 || true
cargo clippy -p alkane-gui --no-deps --release --bins --offline -- -D warnings
cargo clippy --workspace --exclude alkane-gui --exclude wx-rs --all-targets --offline -- -D warnings
- name: Set crate version to ${{ steps.ver.outputs.version }}
if: steps.ver.outputs.release == 'true'
@@ -65,35 +99,36 @@ jobs:
grep -m1 '^version' Cargo.toml
- name: Build release
if: steps.ver.outputs.release == 'true'
run: |
cargo build --release -p alkane-gui --offline
- name: Unit tests
if: steps.ver.outputs.release == 'true'
run: |
cargo test -p alkane-gui --offline
set -o pipefail
cargo test -p alkane-gui --offline 2>&1 | tee tests-gui.txt
cargo test --workspace --exclude alkane-gui --exclude wx-rs --offline 2>&1 | tee tests-core.txt
cat tests-gui.txt tests-core.txt > tests-current.txt
- name: Load previous main benchmark measurement
env:
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
run: python3 ci/bench_history.py prepare
- name: Microbenchmarks
if: steps.ver.outputs.release == 'true'
run: |
# Capture the bench stdout for the weighted-average delta badge (round 19
# #1) while keeping the step a hard gate: pipefail preserves cargo's exit
# code (each bench asserts its own absolute ceiling) even through tee.
# Require every declared benchmark before publishing history or a release.
set -o pipefail
cargo test -p alkane-gui --release --offline -- --ignored --nocapture bench_ \
cargo test -p alkane-gui -p alkane-artifacts --release --offline -- --ignored --nocapture bench_ --test-threads=1 \
| tee bench-current.txt
python3 ci/bench-badge.py --current bench-current.txt \
--baseline badges/bench-baseline.json --no-write
- name: Headless UI self-test
if: steps.ver.outputs.release == 'true'
run: |
apt-get update -qq && apt-get install -y -qq --no-install-recommends \
xvfb xauth dbus-x11 fonts-dejavu-core >/dev/null
BIN=target/release/alkane-toolkit
xvfb-run -a env GDK_BACKEND=x11 ALKANE_SELFTEST=1 "$BIN"
- name: Dependency audit (best-effort)
if: steps.ver.outputs.release == 'true'
continue-on-error: true
run: |
if command -v cargo-audit >/dev/null 2>&1; then
@@ -102,77 +137,66 @@ jobs:
echo "cargo-audit not installed on this runner; skipping"
fi
# Merge coverage from the unit tests AND the headless self-test (ci/coverage.sh)
# so the committed badge reflects real coverage, not the tests-only number a
# plain `cargo llvm-cov` reports. Best-effort: cargo-llvm-cov is fetched as a
# prebuilt binary because the vendored .cargo/config blocks `cargo install`,
# and the instrumented rebuild is slow, so a failure here never blocks a
# release. Feeds steps.cov.outputs.pct to the badge refresh below. xvfb is
# already installed by the self-test step above.
- name: Coverage (best-effort)
- name: Rust compiler cache statistics
if: always()
run: |
if [ -n "${SCCACHE_DIR:-}" ]; then
sccache --show-stats
fi
# Merge coverage from unit tests and the headless UI self-test. A failed
# measurement must not publish a stale badge or create a release.
- name: Coverage
id: cov
if: steps.ver.outputs.release == 'true'
continue-on-error: true
run: |
set -euo pipefail
rustup component add llvm-tools-preview >/dev/null 2>&1 || true
if ! command -v cargo-llvm-cov >/dev/null 2>&1; then
V=0.8.7
URL="https://github.com/taiki-e/cargo-llvm-cov/releases/download/v${V}/cargo-llvm-cov-x86_64-unknown-linux-gnu.tar.gz"
DEST="${CARGO_HOME:-$HOME/.cargo}/bin"
mkdir -p "$DEST"
curl -fsSL "$URL" | tar -xz -C "$DEST" && export PATH="$DEST:$PATH" \
|| echo "cargo-llvm-cov download failed"
fi
if command -v cargo-llvm-cov >/dev/null 2>&1; then
PCT=$(bash ci/coverage.sh --summary-only 2>/dev/null \
| awk '/^TOTAL/{gsub(/%/,"",$10); print $10}')
if [ -n "$PCT" ]; then
echo "pct=${PCT}" >> "$GITHUB_OUTPUT"
echo "line coverage (tests + self-test): ${PCT}%"
else
echo "coverage report produced no TOTAL line; badge left as committed"
fi
else
echo "cargo-llvm-cov unavailable; coverage badge left as committed"
fi
[ "$(cargo llvm-cov --version)" = 'cargo-llvm-cov 0.8.7' ]
PCT=$(bash ci/coverage.sh --summary-only \
| awk '/^TOTAL/{gsub(/%/,"",$10); print $10}')
[ -n "$PCT" ] || { echo "coverage report produced no TOTAL line" >&2; exit 1; }
echo "pct=${PCT}" >> "$GITHUB_OUTPUT"
echo "line coverage (tests + self-test): ${PCT}%"
# Refresh the committed README badges from live metrics and push any change
# back to main. Best-effort: a locked-down runner that can't push must not
# fail the release. A badges-only push does not bump the version (see
# compute-version.sh), so it does not loop back into another release.
- name: Refresh badges
if: steps.ver.outputs.release == 'true'
continue-on-error: true
env:
TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Microbenchmark coverage
id: benchcov
run: |
PASS=$(cargo test -p alkane-gui --offline 2>&1 \
| grep -hoE '[0-9]+ passed' | grep -oE '[0-9]+' | awk '{s+=$1} END{print s+0}')
# Update the coverage badge only when the coverage step produced a number;
# otherwise leave the committed coverage.svg untouched.
COV="${{ steps.cov.outputs.pct }}"
COV_ARG=""
[ -n "$COV" ] && COV_ARG="--coverage $COV"
# Weighted-average microbench delta vs the previous release (round 19 #1).
# bench-badge.py also rewrites badges/bench-baseline.json, which is
# committed below with the SVGs (badges/* does not trip a release bump).
BENCH_DELTA=$(python3 ci/bench-badge.py --current bench-current.txt \
--baseline badges/bench-baseline.json 2>/dev/null || echo NEW)
python3 ci/gen-badges.py --tests "${PASS:-0}" $COV_ARG \
--bench-delta "${BENCH_DELTA:-NEW}" --bench "row-render + scan-parse"
if [ -n "$(git status --porcelain badges)" ]; then
git config user.name "alkane-ci"
git config user.email "ci@bluefla.re"
git add badges
git commit -m "ci: refresh README badges [skip release]"
API="${GITHUB_API_URL:-https://gitea.bluefla.re/api/v1}"
HOST="${API%/api/v1}"
git -c http.extraheader="Authorization: token ${TOKEN}" \
push "${HOST}/${GITHUB_REPOSITORY}.git" "HEAD:main" || echo "badge push skipped"
else
echo "badges unchanged"
fi
set -euo pipefail
command -v cargo-llvm-cov >/dev/null
PCT=$(bash ci/bench-coverage.sh --summary-only \
| awk '/^TOTAL/{gsub(/%/,"",$10); print $10}')
[ -n "$PCT" ] || { echo "microbenchmark coverage unavailable" >&2; exit 1; }
echo "pct=${PCT}" >> "$GITHUB_OUTPUT"
echo "microbenchmark line coverage: ${PCT}%"
- name: Generate measured badges
run: |
set -euo pipefail
PASS=$(grep -E '^test result: ' tests-current.txt \
| grep -oE '[0-9]+ passed' | grep -oE '[0-9]+' \
| awk '{s+=$1} END{print s+0}')
[ "$PASS" -gt 0 ] || { echo "no passing tests counted" >&2; exit 1; }
BENCH_DELTA=$(python3 ci/bench-badge.py --current bench-current.txt \
--baseline badges/bench-baseline.json --no-write)
python3 ci/gen-badges.py --tests "$PASS" \
--coverage "${{ steps.cov.outputs.pct }}" \
--bench-coverage "${{ steps.benchcov.outputs.pct }}" \
--bench-delta "$BENCH_DELTA" --clippy clean
- name: Publish measured badges
env:
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
run: python3 ci/publish-metrics.py
- name: Record private benchmark history
env:
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
run: python3 ci/bench_history.py publish
- uses: https://github.com/ChristopherHX/gitea-upload-artifact@81f940d004763f986ba3582c007fd842dd5cb0d7
with:
name: alkane-toolkit-benchmark-site-preview
path: bench-site/index.html
- name: Package artifact
if: steps.ver.outputs.release == 'true'
id: pkg
@@ -197,22 +221,12 @@ jobs:
- name: Create Gitea release + upload artifact
if: steps.ver.outputs.release == 'true'
env:
TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
TAG="${{ steps.ver.outputs.tag }}"
API="${GITHUB_API_URL:-https://gitea.bluefla.re/api/v1}"
REPO="${GITHUB_REPOSITORY}"
body="Automated ${{ steps.ver.outputs.bump }} release from ${GITHUB_SHA}."
rel=$(curl -sS -X POST -H "Authorization: token ${TOKEN}" -H "Content-Type: application/json" \
"${API}/repos/${REPO}/releases" \
-d "{\"tag_name\":\"${TAG}\",\"target_commitish\":\"${GITHUB_SHA}\",\"name\":\"${TAG}\",\"body\":\"${body}\"}")
id=$(echo "$rel" | grep -oE '"id":[0-9]+' | head -1 | cut -d: -f2)
if [ -z "$id" ]; then echo "release create failed: $rel"; exit 1; fi
curl -sS -X POST -H "Authorization: token ${TOKEN}" -H "Content-Type: application/gzip" \
"${API}/repos/${REPO}/releases/${id}/assets?name=${{ steps.pkg.outputs.assetname }}" \
--data-binary @"${{ steps.pkg.outputs.asset }}" | grep -oE '"browser_download_url":"[^"]+"' || true
echo "Released ${TAG}"
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
run: python3 ci/release-rc.py "${{ steps.ver.outputs.tag }}" false "${{ steps.pkg.outputs.asset }}"
- name: No release needed
if: steps.ver.outputs.release != 'true'
run: echo "No backend/UI change since ${{ steps.ver.outputs.last_tag }} - skipping release."
- name: Clean generated Toolkit build
if: always()
run: python3 ci/cleanup-generated.py
+27
View File
@@ -0,0 +1,27 @@
name: source
on:
pull_request:
branches: [next]
workflow_dispatch:
concurrency:
group: alkane-toolkit-source-${{ github.ref }}
cancel-in-progress: true
jobs:
check:
runs-on: alkane-fast
container:
image: gitea.bluefla.re/blueflare/alkane-ci@sha256:9d2a992bbcb91014af3c85d2e1ec8c5990701cecf83fd06c8d46f9ef13dbd948
env:
CARGO_BUILD_JOBS: 2
steps:
- uses: actions/checkout@v4
- name: Check runner image pins
run: python3 ci/check-runner-image.py
- name: Source checks
run: cargo test --workspace --exclude alkane-gui --exclude wx-rs --offline
- name: Clean generated Toolkit build
if: always()
run: python3 ci/cleanup-generated.py
+106 -23
View File
@@ -1,62 +1,135 @@
name: verify
# Pre-merge quality gate: clippy + build + tests + microbenchmarks + the headless
# UI self-test, plus a best-effort dependency audit. Runs on pull requests and on
# pushes to any branch EXCEPT main (main is gated by release.yml, which repeats
# these checks before it cuts a release -- so no work is duplicated on main).
# Full quality gate for pull requests to main.
on:
pull_request:
push:
branches-ignore: [main]
branches: [main]
concurrency:
group: alkane-toolkit-verify-${{ github.ref }}
cancel-in-progress: true
jobs:
verify:
runs-on: alkane-ci
runs-on: alkane-verify
container:
image: gitea.bluefla.re/blueflare/alkane-ci@sha256:9d2a992bbcb91014af3c85d2e1ec8c5990701cecf83fd06c8d46f9ef13dbd948
env:
CARGO_TARGET_DIR: target
CARGO_BUILD_JOBS: 2
WX_PREFIX: /root/.cache/wx-3.3.3-linux
WX_RS_WXCONFIG: /root/.cache/wx-3.3.3-linux/bin/wx-config
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Check runner image pins
run: python3 ci/check-runner-image.py
- name: Detect changed surface
id: surface
run: python3 ci/pr-surface.py >> "$GITHUB_OUTPUT"
- name: Check documentation change
if: steps.surface.outputs.surface == 'documentation'
run: |
base="$(git merge-base HEAD "origin/$GITHUB_BASE_REF")"
git diff --check "$base" HEAD
if git grep -nIE '^[[:space:]]*-----BEGIN (RSA |EC |OPENSSH )?PRIVATE KEY-----[[:space:]]*$' --; then
echo "private key material found in tracked source" >&2
exit 1
else
status=$?
[ "$status" -eq 1 ]
- name: Check CI change surface
if: steps.surface.outputs.surface != 'documentation'
run: python3 ci/test-pr-surface.py
- name: Install build dependencies
run: |
apt-get update -qq
apt-get install -y -qq --no-install-recommends \
libssl-dev pkg-config ca-certificates >/dev/null
if: steps.surface.outputs.surface != 'documentation'
run: bash ci/ensure-build-deps.sh base
- name: Configure bounded Rust compiler cache
if: steps.surface.outputs.surface != 'documentation'
run: bash ci/configure-rust-cache.sh
- name: Compute wxWidgets cache key
id: wx-key
if: steps.surface.outputs.surface == 'full'
run: bash ci/wx-cache-key.sh
- name: Check prebuilt wxWidgets
id: wx-image
if: steps.surface.outputs.surface == 'full'
run: bash ci/check-wx-image-prefix.sh
- name: Cache vendored wxWidgets build
uses: actions/cache@v4
if: steps.surface.outputs.surface == 'full' && steps.wx-image.outputs.available != 'true'
id: wx-cache
uses: actions/cache/restore@v4
continue-on-error: true
with:
path: /root/.cache/wx-3.3.3-linux
key: wx-3.3.3-${{ runner.os }}-${{ hashFiles('thirdparty/wx-rs/VERSION') }}
key: ${{ steps.wx-key.outputs.key }}
- name: Build wxWidgets (once, then cached)
run: |
if [ ! -x "$WX_PREFIX/bin/wx-config" ]; then
bash scripts/build-wx-linux.sh
else
echo "wx prefix restored from cache"
fi
if: steps.surface.outputs.surface == 'full'
id: wx-build
run: bash ci/ensure-wx-prefix.sh
- name: Save vendored wxWidgets build
if: steps.surface.outputs.surface == 'full' && steps.wx-cache.outputs.cache-hit != 'true' && steps.wx-build.outputs.built == 'true'
uses: actions/cache/save@v4
continue-on-error: true
with:
path: /root/.cache/wx-3.3.3-linux
key: ${{ steps.wx-key.outputs.key }}
- name: Clippy (our crate, warnings are errors)
if: steps.surface.outputs.surface == 'full'
run: |
rustup component add clippy >/dev/null 2>&1 || true
cargo clippy -p alkane-gui --no-deps --release --bins --offline -- -D warnings
cargo clippy --workspace --exclude alkane-gui --exclude wx-rs --all-targets --offline -- -D warnings
- name: Headless crate checks
if: steps.surface.outputs.surface == 'headless'
env:
PACKAGES: ${{ steps.surface.outputs.packages }}
run: |
rustup component add clippy >/dev/null 2>&1 || true
args=()
for package in $PACKAGES; do
case "$package" in
alkane-access|alkane-artifacts|alkane-cli|alkane-flash) args+=(-p "$package") ;;
*) echo "unrecognized crate: $package" >&2; exit 1 ;;
esac
done
[ "${#args[@]}" -gt 0 ]
cargo clippy "${args[@]}" --all-targets --offline -- -D warnings
cargo test "${args[@]}" --offline
- name: Build
if: steps.surface.outputs.surface == 'full'
run: cargo build --release -p alkane-gui --offline
- name: Unit tests
run: cargo test -p alkane-gui --offline
if: steps.surface.outputs.surface == 'full'
run: |
cargo test -p alkane-gui --offline
cargo test --workspace --exclude alkane-gui --exclude wx-rs --offline
- name: Microbenchmarks
run: cargo test -p alkane-gui --release --offline -- --ignored --nocapture bench_
if: steps.surface.outputs.surface == 'full'
run: cargo test -p alkane-gui -p alkane-artifacts --release --offline -- --ignored --nocapture bench_ --test-threads=1
- name: Headless UI self-test
if: steps.surface.outputs.surface == 'full'
run: |
apt-get update -qq && apt-get install -y -qq --no-install-recommends \
xvfb xauth dbus-x11 fonts-dejavu-core >/dev/null
bash ci/ensure-build-deps.sh ui
BIN=target/release/alkane-toolkit
xvfb-run -a env GDK_BACKEND=x11 ALKANE_SELFTEST=1 "$BIN"
@@ -65,6 +138,7 @@ jobs:
# runner must not fail the gate on it. Accepted advisories live in
# .cargo/audit.toml.
- name: Dependency audit (best-effort)
if: steps.surface.outputs.surface != 'documentation'
continue-on-error: true
run: |
if command -v cargo-audit >/dev/null 2>&1; then
@@ -72,3 +146,12 @@ jobs:
else
echo "cargo-audit not installed on this runner; skipping"
fi
- name: Rust compiler cache statistics
if: always() && steps.surface.outputs.surface != 'documentation'
run: |
if [ -n "${SCCACHE_DIR:-}" ]; then
sccache --show-stats
fi
- name: Clean generated Toolkit build
if: always()
run: python3 ci/cleanup-generated.py
+1
View File
@@ -1,3 +1,4 @@
/target
**/target
.claude/
__pycache__/
Generated
+7
View File
@@ -40,12 +40,15 @@ name = "alkane-artifacts"
version = "0.1.0"
dependencies = [
"alkane-core",
"sha2",
"thiserror",
]
[[package]]
name = "alkane-cli"
version = "0.1.0"
dependencies = [
"alkane-artifacts",
"alkane-core",
]
@@ -69,7 +72,11 @@ dependencies = [
name = "alkane-flash"
version = "0.1.0"
dependencies = [
"alkane-artifacts",
"alkane-core",
"sha2",
"tempfile",
"thiserror",
]
[[package]]
+39 -95
View File
@@ -1,116 +1,60 @@
# alkane-toolkit
# Alkane Toolkit
[![CI](https://gitea.bluefla.re/blueflare/alkane-toolkit/actions/workflows/release.yml/badge.svg)](https://gitea.bluefla.re/blueflare/alkane-toolkit/actions)
![tests](badges/tests.svg)
![coverage](badges/coverage.svg)
![bench](badges/bench.svg)
![lines of code](badges/loc.svg)
![clippy](badges/quality.svg)
![dependencies](badges/dependencies.svg)
![license](badges/license.svg)
[![CI](https://gitea.bluefla.re/blueflare/alkane-toolkit/raw/branch/ci-badges/main.svg)](https://gitea.bluefla.re/blueflare/alkane-toolkit/actions)
![tests](https://gitea.bluefla.re/blueflare/alkane-toolkit/raw/branch/ci-badges/badges/tests.svg)
![coverage](https://gitea.bluefla.re/blueflare/alkane-toolkit/raw/branch/ci-badges/badges/coverage.svg)
![bench](https://gitea.bluefla.re/blueflare/alkane-toolkit/raw/branch/ci-badges/badges/bench.svg)
![bench coverage](https://gitea.bluefla.re/blueflare/alkane-toolkit/raw/branch/ci-badges/badges/bench-coverage.svg)
![lines of code](https://gitea.bluefla.re/blueflare/alkane-toolkit/raw/branch/ci-badges/badges/loc.svg)
![code quality](https://gitea.bluefla.re/blueflare/alkane-toolkit/raw/branch/ci-badges/badges/quality.svg)
![dependencies](https://gitea.bluefla.re/blueflare/alkane-toolkit/raw/branch/ci-badges/badges/dependencies.svg)
![license](https://gitea.bluefla.re/blueflare/alkane-toolkit/raw/branch/ci-badges/badges/license.svg)
A cross-platform desktop toolkit for discovering, monitoring, and re-flashing
ASIC miners. It scans a fleet over the network, shows live health and hashrate
in a sortable table, and installs **stock** or **alkaneOS** firmware onto a
control board whatever it currently runs (stock, VNish/AnthillOS, Braiins OS+,
LuxOS, ePIC, HiveOn, BixBit, WardenOS).
Desktop miner discovery and monitoring. The Rust GUI uses wxWidgets through
a patched [wx-rs bridge](thirdparty/wx-rs). Firmware installation is under
development.
The core and UI are pure Rust; the native window is wxWidgets driven through a
vendored, patched [wx-rs](thirdparty/wx-rs) bridge, so there is no Electron,
no web view, and a single self-contained binary per platform.
## What it does
- **Discover** a fleet by CIDR or IP range and identify each miner's make,
model, control board, and firmware (via a vendored [asic-rs](vendor/asic-rs)).
- **Monitor** hashrate vs. expected, per-board health, chip temperatures, fans,
PSU state, and pool workers, with an Excel-style filter and drag-reorderable
columns.
- **Operate** miners from a right-click menu: flash the locate light, pause /
resume, restart, set a power or hashrate target, select a firmware profile
(LuxOS/VNish presets), configure pools, set the timezone, and change the
password -- each action offered only when every selected miner supports it.
- **Install firmware**: push stock or aftermarket images, or revert an
aftermarket miner to stock, behind a typed confirmation.
Discovery and telemetry are read-only and safe to run against any fleet; every
mutating action is capability-gated and, where destructive, confirmed.
## Build and run (Debian/Ubuntu)
## Run locally
```sh
scripts/build-wx-linux.sh # once: builds the vendored wxWidgets 3.3.3 into ~/.cache
scripts/build-gui-linux.sh # cargo build --release -p alkane-gui
~/.cache/alkane-tk-target/release/alkane-toolkit
scripts/build-wx-linux.sh
scripts/build-gui-linux.sh
ALKANE_FAKE_SCAN=1 ~/.cache/alkane-tk-target/release/alkane-toolkit
```
Runtime needs GTK 3: `sudo apt install libgtk-3-0`. To explore the UI with no
hardware, run the offline demo fleet:
The first command builds wxWidgets 3.3.3 once. Linux needs GTK 3. Fake scan
uses offline fixtures and does not contact hardware. For Windows and macOS,
use the matching `scripts/build-gui-*.sh` script.
```sh
ALKANE_FAKE_SCAN=1 alkane-toolkit
```
## Current scope
Windows and macOS share all GUI code; only the C++ bridge and wx build differ
(`scripts/build-gui-windows.sh` needs an msys2 toolchain, `-macos.sh` needs a
Mac).
- Discover miners by CIDR or IP range with vendored [asic-rs](vendor/asic-rs).
- Show model, firmware, health, hashrate, temperatures, fans, PSU, and workers.
- Filter and sort the desktop table; inspect probes with `miner_probe`.
## Command-line probe
`miner_probe` is a headless companion for hardware checks that should not go
through the window event loop -- discovery, telemetry, and each write action:
```sh
miner_probe scan 10.0.0.0/24 # discover + telemetry (TSV)
miner_probe presets 10.0.0.5 # list a firmware's selectable profiles
miner_probe setpreset 10.0.0.5 540MHz
```
Run `miner_probe` with no arguments for the full verb list.
Discovery is read-only. The installer and operator actions remain in the
[implementation plan](docs/IMPLEMENTATION-PLAN.md) and
[firmware matrix](docs/aftermarket-parity-roadmap.md).
## Development
```sh
export WX_RS_WXCONFIG="$HOME/.cache/wx-3.3.3-linux/bin/wx-config"
export CARGO_TARGET_DIR="$HOME/.cache/alkane-tk-target" # keep the target tree off the source share
cargo test -p alkane-gui # unit tests
cargo test -p alkane-gui --release -- --ignored bench_ # microbenchmarks
cargo clippy -p alkane-gui --no-deps --bins -- -D warnings # lint gate
xvfb-run -a env ALKANE_SELFTEST=1 \
"$CARGO_TARGET_DIR/release/alkane-toolkit" # headless UI self-test
ci/coverage.sh --summary-only # coverage (tests + self-test)
WX_RS_WXCONFIG="$HOME/.cache/wx-3.3.3-linux/bin/wx-config" \
CARGO_TARGET_DIR="$HOME/.cache/alkane-tk-target" \
cargo test -p alkane-gui --offline
```
CI mirrors these: `verify.yml` runs the lint, tests, benchmarks, self-test, and
a best-effort dependency audit on every pull request and branch push;
`release.yml` repeats them on `main` and cuts an `X.Y.Z` release with the built
binary attached when the change warrants it. Dependencies are vendored under
`vendor/`, so builds never touch the network.
Keep build output off the source share. `main` runs full CI and publishes
qualifying releases; `next` builds `-rc` candidates. Badges measure host
code, not installation support. See the public
[benchmark history](https://blueflare.gitea.bluefla.re/alkane-benchmarks/toolkit/).
## Architecture
## Firmware safety
- `crates/alkane-gui` -- the application: scan engine, data model, wxWidgets UI,
and the `miner_probe` CLI (the other `crates/alkane-*` are early scaffolding).
- `vendor/asic-rs` -- the miner-discovery and control library, vendored and
extended through numbered patches under `thirdparty/asic-rs/patches`.
- `thirdparty/wx-rs` -- the patched wxWidgets bridge (see `docs/adr/0002`,
`0003`).
See [`docs/IMPLEMENTATION-PLAN.md`](docs/IMPLEMENTATION-PLAN.md) for the roadmap
and [`docs/aftermarket-parity-roadmap.md`](docs/aftermarket-parity-roadmap.md)
for the firmware config/scan parity work.
## Firmware safety rules
Encoded in code, from alkane-sdk `docs/install-methods.md`:
1. Never write the bootloader or secure region.
2. Verify on a channel the installer does not control.
3. Reboot is root-only; a dropped SSH connection can still be success.
4. A packer is per board; never reuse one across boards.
5. Boot-switch handling is an explicit, verified step.
Installation must follow the [SDK install rules](https://gitea.bluefla.re/blueflare/alkane-sdk/src/branch/main/docs/install-methods.md):
use the exact board's packer and boot-switch procedure, verify through an
independent channel, and never write bootloader or secure regions.
## License
Licensed under the [MIT license](LICENSE).
[MIT](LICENSE). Vendored dependencies keep their own terms.
+9 -9
View File
@@ -1,11 +1,11 @@
{
"bench_parse_line_near_max_addrs": 3901086.0,
"bench_parse_targets_many_ranges_near_cap": 290127400.0,
"bench_render_cells": 29363207.0,
"bench_sort_by_each_column": 4468641.0,
"bench_targets_to_cidrs_large_range": 3605972.0,
"bench_upsert_cold_start_population": 91616782.0,
"bench_view_pipeline": 1396303.0,
"bench_view_pipeline_default_sort": 2723906.0,
"bench_view_pipeline_with_filter": 1491721.0
"bench_parse_line_near_max_addrs": 807160.0,
"bench_parse_targets_many_ranges_near_cap": 54465485.0,
"bench_render_cells": 3503112.0,
"bench_sort_by_each_column": 486975.0,
"bench_targets_to_cidrs_large_range": 482167.0,
"bench_upsert_cold_start_population": 8315814.0,
"bench_view_pipeline": 191794.0,
"bench_view_pipeline_default_sort": 193214.0,
"bench_view_pipeline_with_filter": 253085.0
}
+19
View File
@@ -0,0 +1,19 @@
<svg xmlns="http://www.w3.org/2000/svg" width="128.0" height="20" role="img" aria-label="bench coverage: 7%">
<title>bench coverage: 7%</title>
<linearGradient id="s" x2="0" y2="100%">
<stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
<stop offset="1" stop-opacity=".1"/>
</linearGradient>
<clipPath id="r"><rect width="128.0" height="20" rx="3" fill="#fff"/></clipPath>
<g clip-path="url(#r)">
<rect width="103.0" height="20" fill="#555"/>
<rect x="103.0" width="25.0" height="20" fill="#e05d44"/>
<rect width="128.0" height="20" fill="url(#s)"/>
</g>
<g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" font-size="11">
<text x="51.5" y="15" fill="#010101" fill-opacity=".3">bench coverage</text>
<text x="51.5" y="14">bench coverage</text>
<text x="115.5" y="15" fill="#010101" fill-opacity=".3">7%</text>
<text x="115.5" y="14">7%</text>
</g>
</svg>

After

Width:  |  Height:  |  Size: 946 B

+7 -7
View File
@@ -1,19 +1,19 @@
<svg xmlns="http://www.w3.org/2000/svg" width="147.5" height="20" role="img" aria-label="bench: +52.9% vs prev">
<title>bench: +52.9% vs prev</title>
<svg xmlns="http://www.w3.org/2000/svg" width="141.0" height="20" role="img" aria-label="bench: +7.4% vs prev">
<title>bench: +7.4% vs prev</title>
<linearGradient id="s" x2="0" y2="100%">
<stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
<stop offset="1" stop-opacity=".1"/>
</linearGradient>
<clipPath id="r"><rect width="147.5" height="20" rx="3" fill="#fff"/></clipPath>
<clipPath id="r"><rect width="141.0" height="20" rx="3" fill="#fff"/></clipPath>
<g clip-path="url(#r)">
<rect width="44.5" height="20" fill="#555"/>
<rect x="44.5" width="103.0" height="20" fill="#fe7d37"/>
<rect width="147.5" height="20" fill="url(#s)"/>
<rect x="44.5" width="96.5" height="20" fill="#dfb317"/>
<rect width="141.0" height="20" fill="url(#s)"/>
</g>
<g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" font-size="11">
<text x="22.2" y="15" fill="#010101" fill-opacity=".3">bench</text>
<text x="22.2" y="14">bench</text>
<text x="96.0" y="15" fill="#010101" fill-opacity=".3">+52.9% vs prev</text>
<text x="96.0" y="14">+52.9% vs prev</text>
<text x="92.8" y="15" fill="#010101" fill-opacity=".3">+7.4% vs prev</text>
<text x="92.8" y="14">+7.4% vs prev</text>
</g>
</svg>

Before

Width:  |  Height:  |  Size: 955 B

After

Width:  |  Height:  |  Size: 950 B

+4 -4
View File
@@ -1,5 +1,5 @@
<svg xmlns="http://www.w3.org/2000/svg" width="141.0" height="20" role="img" aria-label="lines of code: 13.5k">
<title>lines of code: 13.5k</title>
<svg xmlns="http://www.w3.org/2000/svg" width="141.0" height="20" role="img" aria-label="lines of code: 13.7K">
<title>lines of code: 13.7K</title>
<linearGradient id="s" x2="0" y2="100%">
<stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
<stop offset="1" stop-opacity=".1"/>
@@ -13,7 +13,7 @@
<g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" font-size="11">
<text x="48.2" y="15" fill="#010101" fill-opacity=".3">lines of code</text>
<text x="48.2" y="14">lines of code</text>
<text x="118.8" y="15" fill="#010101" fill-opacity=".3">13.5k</text>
<text x="118.8" y="14">13.5k</text>
<text x="118.8" y="15" fill="#010101" fill-opacity=".3">13.7K</text>
<text x="118.8" y="14">13.7K</text>
</g>
</svg>

Before

Width:  |  Height:  |  Size: 952 B

After

Width:  |  Height:  |  Size: 952 B

+10 -10
View File
@@ -1,19 +1,19 @@
<svg xmlns="http://www.w3.org/2000/svg" width="95.5" height="20" role="img" aria-label="clippy: clean">
<title>clippy: clean</title>
<svg xmlns="http://www.w3.org/2000/svg" width="108.5" height="20" role="img" aria-label="code quality: A">
<title>code quality: A</title>
<linearGradient id="s" x2="0" y2="100%">
<stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
<stop offset="1" stop-opacity=".1"/>
</linearGradient>
<clipPath id="r"><rect width="95.5" height="20" rx="3" fill="#fff"/></clipPath>
<clipPath id="r"><rect width="108.5" height="20" rx="3" fill="#fff"/></clipPath>
<g clip-path="url(#r)">
<rect width="51.0" height="20" fill="#555"/>
<rect x="51.0" width="44.5" height="20" fill="#4c1"/>
<rect width="95.5" height="20" fill="url(#s)"/>
<rect width="90.0" height="20" fill="#555"/>
<rect x="90.0" width="18.5" height="20" fill="#4c1"/>
<rect width="108.5" height="20" fill="url(#s)"/>
</g>
<g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" font-size="11">
<text x="25.5" y="15" fill="#010101" fill-opacity=".3">clippy</text>
<text x="25.5" y="14">clippy</text>
<text x="73.2" y="15" fill="#010101" fill-opacity=".3">clean</text>
<text x="73.2" y="14">clean</text>
<text x="45.0" y="15" fill="#010101" fill-opacity=".3">code quality</text>
<text x="45.0" y="14">code quality</text>
<text x="99.2" y="15" fill="#010101" fill-opacity=".3">A</text>
<text x="99.2" y="14">A</text>
</g>
</svg>

Before

Width:  |  Height:  |  Size: 916 B

After

Width:  |  Height:  |  Size: 927 B

+4 -4
View File
@@ -1,5 +1,5 @@
<svg xmlns="http://www.w3.org/2000/svg" width="121.5" height="20" role="img" aria-label="tests: 93 passing">
<title>tests: 93 passing</title>
<svg xmlns="http://www.w3.org/2000/svg" width="121.5" height="20" role="img" aria-label="tests: 95 passing">
<title>tests: 95 passing</title>
<linearGradient id="s" x2="0" y2="100%">
<stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
<stop offset="1" stop-opacity=".1"/>
@@ -13,7 +13,7 @@
<g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" font-size="11">
<text x="22.2" y="15" fill="#010101" fill-opacity=".3">tests</text>
<text x="22.2" y="14">tests</text>
<text x="83.0" y="15" fill="#010101" fill-opacity=".3">93 passing</text>
<text x="83.0" y="14">93 passing</text>
<text x="83.0" y="15" fill="#010101" fill-opacity=".3">95 passing</text>
<text x="83.0" y="14">95 passing</text>
</g>
</svg>

Before

Width:  |  Height:  |  Size: 935 B

After

Width:  |  Height:  |  Size: 935 B

+54
View File
@@ -0,0 +1,54 @@
# SPDX-License-Identifier: MIT
"""Write small badge artifacts to the private Gitea CI badge branch."""
import base64
import json
from urllib.error import HTTPError
from urllib.parse import quote
from urllib.request import Request, urlopen
BADGE_BRANCH = "ci-badges"
def request_json(url: str, token: str, method: str = "GET",
payload: dict | None = None) -> dict:
body = None if payload is None else json.dumps(payload).encode()
request = Request(url, data=body, method=method,
headers={"Authorization": f"token {token}",
"Content-Type": "application/json"})
with urlopen(request, timeout=20) as response:
return json.load(response)
def publish_file(api: str, repo: str, filename: str, data: bytes,
token: str, message: str, max_bytes: int = 65_536) -> None:
if not filename or filename.startswith("/") or any(
part in ("", ".", "..") for part in filename.split("/")):
raise ValueError("invalid badge path")
if len(data) > max_bytes:
raise ValueError("artifact exceeds size limit")
path = f"{api}/repos/{repo}/contents/{quote(filename, safe='/')}"
encoded = base64.b64encode(data).decode("ascii")
for attempt in range(3):
try:
current = request_json(path + "?ref=" + BADGE_BRANCH, token)
if base64.b64decode(current["content"]) == data:
return
sha = current["sha"]
method = "PUT"
except HTTPError as error:
if error.code != 404:
raise
sha = None
method = "POST"
payload = {"branch": BADGE_BRANCH, "content": encoded,
"message": message + " [skip ci]"}
if sha is not None:
payload["sha"] = sha
try:
request_json(path, token, method, payload)
return
except HTTPError as error:
if error.code not in (409, 422) or attempt == 2:
raise
raise RuntimeError("badge write did not complete")
+58 -46
View File
@@ -1,27 +1,8 @@
#!/usr/bin/env python3
"""Compute the weighted-average microbenchmark delta versus the previous release.
Reads the captured stdout of `cargo test ... --ignored --nocapture bench_` (whose
timings are Rust `Duration` Debug strings: "12.3ms", "512us"/"512µs", "840ns",
"1.2s"), compares each bench to a committed baseline of the previous release's
numbers, and prints the time-weighted average change as a signed percentage:
(sum(current) / sum(baseline) - 1) * 100 over benches present in both
Weighting by duration means the slow benches dominate, so the number tracks
overall wall-time change rather than giving a tiny bench equal say. Then the
baseline is rewritten with the current numbers, so the next release compares
against this one ("the previous commit").
Usage:
bench-badge.py --current bench-current.txt --baseline badges/bench-baseline.json
Prints the delta as a plain number (e.g. "-3.2", or "NEW" when there is no
usable baseline) to stdout. The baseline JSON lives under badges/ so committing
it back does not trip compute-version.sh's path-based release bump.
"""
"""Check the Toolkit benchmark suite and compare it with the prior release."""
import argparse
import json
import math
import os
import re
import sys
@@ -29,9 +10,17 @@ import sys
# A Duration Debug token: a number immediately followed by a time unit, with the
# multi-char units listed before the bare "s" so alternation prefers them. The
# trailing (?![a-zA-Z]) stops "s" in words like "rows"/"cidrs" from matching.
_DUR = re.compile(r"([0-9]+(?:\.[0-9]+)?)\s*(ns|µs|us|ms|s)(?![a-zA-Z])")
_UNIT_NS = {"ns": 1.0, "us": 1e3, "µs": 1e3, "ms": 1e6, "s": 1e9}
_NAME = re.compile(r"^(bench_[A-Za-z0-9_]+)\s*:")
_DUR = re.compile(r"([0-9]+(?:\.[0-9]+)?)\s*(ns|\u00b5s|us|ms|s)(?![a-zA-Z])")
_UNIT_NS = {"ns": 1.0, "us": 1e3, "\u00b5s": 1e3, "ms": 1e6, "s": 1e9}
_NAME = re.compile(r"^(?:test [A-Za-z0-9_:]+ \.\.\. )?(bench_[A-Za-z0-9_]+)\s*:")
EXPECTED_BENCHES = {
"bench_verify_artifact", "bench_naming_transforms",
"bench_parse_line_near_max_addrs", "bench_parse_targets_many_ranges_near_cap",
"bench_targets_to_cidrs_large_range", "bench_view_pipeline",
"bench_render_cells", "bench_health_diagnostics",
"bench_view_pipeline_default_sort", "bench_sort_by_each_column",
"bench_view_pipeline_with_filter", "bench_upsert_cold_start_population",
}
def parse_bench(text: str) -> dict:
@@ -44,12 +33,33 @@ def parse_bench(text: str) -> dict:
continue
durs = _DUR.findall(line)
if not durs:
continue
raise ValueError(f"missing timing for {m.group(1)}")
val, unit = durs[-1]
out[m.group(1)] = float(val) * _UNIT_NS[unit]
elapsed = float(val) * _UNIT_NS[unit]
if m.group(1) in out or not math.isfinite(elapsed) or elapsed <= 0:
raise ValueError(f"duplicate or invalid timing for {m.group(1)}")
out[m.group(1)] = elapsed
return out
def require_suite(results: dict) -> dict:
if results.keys() != EXPECTED_BENCHES:
raise ValueError("microbenchmark results differ from the declared suite")
return results
def benchmark_delta(current: dict, baseline: dict) -> float | None:
"""Average each comparable benchmark's percentage improvement."""
if not baseline:
return None
changes = [(baseline[name] - current[name]) / baseline[name]
for name in baseline]
delta = math.fsum(changes) / len(changes) * 100
if not math.isfinite(delta):
raise ValueError("benchmark comparison is not finite")
return delta
def main() -> int:
ap = argparse.ArgumentParser()
ap.add_argument("--current", required=True, help="captured bench stdout")
@@ -59,32 +69,34 @@ def main() -> int:
try:
with open(args.current, encoding="utf-8") as fh:
current = parse_bench(fh.read())
except OSError as e:
current = require_suite(parse_bench(fh.read()))
except (OSError, ValueError) as e:
print(f"bench-badge: cannot read current results: {e}", file=sys.stderr)
print("NEW")
return 0
if not current:
print("bench-badge: no bench lines parsed from current results", file=sys.stderr)
print("NEW")
return 0
return 1
baseline = {}
try:
with open(args.baseline, encoding="utf-8") as fh:
baseline = {k: float(v) for k, v in json.load(fh).items()}
except (OSError, ValueError):
baseline = {}
baseline = json.load(fh)
except FileNotFoundError:
pass
except (OSError, ValueError) as e:
print(f"bench-badge: invalid baseline: {e}", file=sys.stderr)
return 1
if (not isinstance(baseline, dict)
or not set(baseline).issubset(current)
or any(not isinstance(value, (int, float)) or isinstance(value, bool)
or not math.isfinite(value) or value <= 0
for value in baseline.values())):
print("bench-badge: invalid or retired benchmark in baseline", file=sys.stderr)
return 1
common = [k for k in current if k in baseline and baseline[k] > 0]
if common:
sum_new = sum(current[k] for k in common)
sum_old = sum(baseline[k] for k in common)
delta = (sum_new / sum_old - 1.0) * 100.0 if sum_old > 0 else 0.0
print(f"{delta:.1f}")
else:
print("NEW")
try:
delta = benchmark_delta(current, baseline)
except ValueError as error:
print(f"bench-badge: {error}", file=sys.stderr)
return 1
print("NEW" if delta is None else f"{delta:.1f}")
if not args.no_write:
os.makedirs(os.path.dirname(args.baseline) or ".", exist_ok=True)
+8
View File
@@ -0,0 +1,8 @@
#!/usr/bin/env bash
# Measure only instrumented microbenchmarks, excluding unit and UI tests.
set -euo pipefail
export WX_RS_WXCONFIG="${WX_RS_WXCONFIG:-$HOME/.cache/wx-3.3.3-linux/bin/wx-config}"
cargo llvm-cov clean --workspace
cargo llvm-cov --no-report --offline --release -p alkane-gui -p alkane-artifacts -- \
--ignored --nocapture bench_
cargo llvm-cov report --release --ignore-filename-regex '(thirdparty|vendor)/' "$@"
+166
View File
@@ -0,0 +1,166 @@
#!/usr/bin/env python3
# SPDX-License-Identifier: MIT
"""Keep measured main-branch benchmarks in the private CI artifact branch."""
import argparse
import base64
from datetime import datetime, timezone
import html
import json
import math
import os
from pathlib import Path
import re
import subprocess
import importlib.util
from urllib.error import HTTPError
from urllib.parse import quote
from badge_store import BADGE_BRANCH, publish_file, request_json
from bench_host import identity as benchmark_host
bench_spec = importlib.util.spec_from_file_location(
"bench_badge", Path(__file__).with_name("bench-badge.py"))
bench_badge = importlib.util.module_from_spec(bench_spec)
bench_spec.loader.exec_module(bench_badge)
INDEX = "history/index.json"
MAX_INDEX_ENTRIES = 50
def read_artifact(api: str, repo: str, token: str, filename: str):
url = f"{api}/repos/{repo}/contents/{quote(filename, safe='/')}?ref={BADGE_BRANCH}"
try:
value = request_json(url, token)
except HTTPError as error:
if error.code == 404:
return None
raise
return json.loads(base64.b64decode(value["content"]))
def valid_benches(metrics: dict) -> dict[str, float]:
values = metrics.get("bench_ns_per_op")
if not isinstance(values, dict) or not values:
raise ValueError("benchmark measurements are missing")
if any(not isinstance(key, str) or not re.fullmatch(r"[A-Za-z0-9_]+", key)
or not isinstance(value, (float, int)) or isinstance(value, bool)
or not math.isfinite(value) or value <= 0 for key, value in values.items()):
raise ValueError("benchmark measurements are invalid")
return values
def git_distance(ancestor: str, sha: str) -> int | None:
result = subprocess.run(("git", "rev-list", "--count", f"{ancestor}..{sha}"),
capture_output=True, text=True, check=False)
if result.returncode != 0:
return None
ancestor_check = subprocess.run(("git", "merge-base", "--is-ancestor", ancestor, sha),
capture_output=True, check=False)
return int(result.stdout.strip()) if ancestor_check.returncode == 0 else None
def previous_measurement(index: dict, sha: str, distance=None, host=None) -> dict:
distance = distance or git_distance
choices = []
for entry in index.get("entries", []):
ancestor = entry.get("sha")
if ancestor == sha or not isinstance(ancestor, str):
continue
if host is not None and entry.get("metrics", {}).get("bench_host") != host:
continue
gap = distance(ancestor, sha)
if gap is not None and gap > 0:
choices.append((gap, entry))
if not choices:
return {}
return valid_benches(min(choices, key=lambda item: item[0])[1]["metrics"])
def updated_index(index: dict, sha: str, metrics: dict, timestamp: str) -> dict:
if not re.fullmatch(r"[0-9a-f]{40}", sha):
raise ValueError("invalid commit SHA")
valid_benches(metrics)
entries = [entry for entry in index.get("entries", []) if entry.get("sha") != sha]
entries.append({"sha": sha, "timestamp": timestamp, "metrics": metrics})
return {"schema": 1, "entries": entries[-MAX_INDEX_ENTRIES:]}
def render_html(index: dict) -> str:
entries = list(reversed(index.get("entries", [])))
names = sorted({name for entry in entries
for name in valid_benches(entry["metrics"])})
rows = []
for entry in entries:
sha = entry["sha"]
if not re.fullmatch(r"[0-9a-f]{40}", sha):
raise ValueError("invalid commit SHA in history")
cells = [f'<td><a href="https://gitea.bluefla.re/blueflare/alkane-toolkit/commit/{sha}">{sha[:10]}</a></td>',
f'<td>{html.escape(entry["timestamp"])}</td>']
values = valid_benches(entry["metrics"])
host = entry["metrics"].get("bench_host", {})
host_label = host.get("cpu_model", "unknown") if isinstance(host, dict) else "unknown"
cells.append(f'<td>{html.escape(str(host_label))}</td>')
cells += [f'<td>{values[name]:.3f}</td>' if name in values else '<td>new</td>'
for name in names]
rows.append("<tr>" + "".join(cells) + "</tr>")
headings = "".join(f"<th scope=\"col\">{html.escape(name)} (ns/op)</th>" for name in names)
return ("<!doctype html>\n<html lang=\"en\"><head><meta charset=\"utf-8\">"
"<meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">"
"<title>Alkane Toolkit benchmarks</title><style>"
"body{font:16px system-ui,sans-serif;max-width:1100px;margin:2rem auto;padding:0 1rem;color:#17212b}"
"h1{font-size:2rem}p{max-width:70ch;line-height:1.5}"
"table{border-collapse:collapse;min-width:100%}th,td{padding:.5rem;border-bottom:1px solid #ccd3da;text-align:right}"
"th:first-child,td:first-child{text-align:left}th:nth-child(2),td:nth-child(2){text-align:left}"
"th{background:#edf2f6;position:sticky;top:0}a{color:#145a9a}"
".scroll{overflow-x:auto}small{color:#55616d}</style></head><body>"
"<h1>Alkane Toolkit microbenchmarks</h1>"
"<p>Measured on main CI. Lower ns/op is faster. Results depend on runner load and are "
"not board performance. A new benchmark has no earlier comparison.</p>"
f"<p><small>Most recent {len(entries)} measured commits. Full per-commit JSON is retained "
"in the private ci-badges branch.</small></p>"
f"<div class=\"scroll\"><table><thead><tr><th scope=\"col\">Commit</th>"
f"<th scope=\"col\">UTC</th><th scope=\"col\">CPU</th>{headings}</tr></thead><tbody>{''.join(rows)}"
"</tbody></table></div></body></html>\n")
def main() -> None:
parser = argparse.ArgumentParser()
parser.add_argument("action", choices=("prepare", "publish", "render"))
args = parser.parse_args()
api = os.environ["GITHUB_API_URL"].rstrip("/")
repo = os.environ["GITHUB_REPOSITORY"]
token = os.environ["GITEA_TOKEN"]
sha = os.environ["GITHUB_SHA"]
index = read_artifact(api, repo, token, INDEX) or {"schema": 1, "entries": []}
if index.get("schema") != 1 or not isinstance(index.get("entries"), list):
raise ValueError("unsupported benchmark history index")
if args.action == "prepare":
baseline = previous_measurement(index, sha, host=benchmark_host())
Path("badges").mkdir(exist_ok=True)
Path("badges/bench-baseline.json").write_text(json.dumps(baseline) + "\n")
print(f"Loaded {len(baseline)} prior benchmark measurements")
return
if args.action == "render":
if not index["entries"]:
raise ValueError("no measured benchmark history to publish")
Path("bench-site").mkdir(exist_ok=True)
Path("bench-site/index.html").write_text(render_html(index))
print(f"Rendered {len(index['entries'])} measured benchmark commits")
return
metrics = {"bench_ns_per_op": bench_badge.require_suite(bench_badge.parse_bench(
Path("bench-current.txt").read_text())), "bench_host": benchmark_host()}
timestamp = datetime.now(timezone.utc).isoformat(timespec="seconds")
index = updated_index(index, sha, metrics, timestamp)
record = json.dumps(index["entries"][-1], indent=2).encode() + b"\n"
publish_file(api, repo, f"history/{sha}.json", record, token,
"Record Alkane Toolkit benchmarks", max_bytes=1_048_576)
publish_file(api, repo, INDEX, json.dumps(index, indent=2).encode() + b"\n",
token, "Update Alkane Toolkit benchmark index", max_bytes=1_048_576)
Path("bench-site").mkdir(exist_ok=True)
Path("bench-site/index.html").write_text(render_html(index))
print(f"Recorded benchmarks for {sha[:10]}")
if __name__ == "__main__":
main()
+19
View File
@@ -0,0 +1,19 @@
#!/usr/bin/env python3
# SPDX-License-Identifier: MIT
"""Identify the CPU class used for comparable CI microbenchmark baselines."""
import os
import platform
from pathlib import Path
def identity() -> dict[str, object]:
model = "unknown"
cpuinfo = Path("/proc/cpuinfo")
if cpuinfo.is_file():
for line in cpuinfo.read_text(errors="replace").splitlines():
if line.startswith(("model name\t", "Hardware\t", "Processor\t")):
model = line.partition(":")[2].strip()[:160]
break
return {"architecture": platform.machine(), "cpu_model": model,
"logical_cpus": os.cpu_count() or 1}
+64
View File
@@ -0,0 +1,64 @@
#!/usr/bin/env python3
# SPDX-License-Identifier: MIT
"""Keep Toolkit CI on the verified Alkane runner image."""
from pathlib import Path
import re
import sys
import yaml
ROOT = Path(__file__).resolve().parents[1]
IMAGE = (ROOT / "ci/runner-image.txt").read_text().strip()
def main() -> int:
if not re.fullmatch(
r"gitea\.bluefla\.re/blueflare/alkane-ci@sha256:[0-9a-f]{64}", IMAGE
):
print("Runner image must be pinned by Gitea registry digest", file=sys.stderr)
return 1
for path in sorted((ROOT / ".gitea/workflows").glob("*.yml")):
workflow = yaml.load(path.read_text(), Loader=yaml.BaseLoader)
for name, job in workflow.get("jobs", {}).items():
if job.get("runs-on") not in {"alkane-ci", "alkane-fast", "alkane-verify"}:
continue
if job.get("container", {}).get("image") != IMAGE:
print(f"{path.name}: {name} has a different runner image", file=sys.stderr)
return 1
pages = yaml.load(
(ROOT / ".gitea/workflows/bench-pages.yml").read_text(),
Loader=yaml.BaseLoader,
)
if (pages["on"]["workflow_run"]["workflows"] != ["build-test-release"]
or pages["jobs"]["publish"].get("runs-on") != "alkane-pages"):
print("Benchmark Pages must follow main CI on the Pages runner", file=sys.stderr)
return 1
release = yaml.load(
(ROOT / ".gitea/workflows/release.yml").read_text(),
Loader=yaml.BaseLoader,
)
if release["jobs"]["release"].get("runs-on") != "alkane-ci":
print("Main release must use the dedicated Alkane build pool", file=sys.stderr)
return 1
if any("ci/publish-bench-pages.py" in step.get("run", "")
for step in release["jobs"]["release"]["steps"]):
print("Main release must not publish Pages from GARM", file=sys.stderr)
return 1
source = yaml.load(
(ROOT / ".gitea/workflows/source.yml").read_text(),
Loader=yaml.BaseLoader,
)
triggers = source["on"]
if (triggers.get("pull_request", {}).get("branches") != ["next"]
or "push" in triggers or "workflow_dispatch" not in triggers):
print("Source checks must not duplicate main pull request verification",
file=sys.stderr)
return 1
print("Toolkit runner image pins: PASS")
return 0
if __name__ == "__main__":
raise SystemExit(main())
+16
View File
@@ -0,0 +1,16 @@
#!/usr/bin/env bash
# SPDX-License-Identifier: MIT
# Avoid a runner-local cache download when the pinned image has this source.
set -euo pipefail
prefix="${WX_PREFIX:?WX_PREFIX is required}"
expected="$(awk '$1 == "sha256:" {print $2}' thirdparty/wxwidgets/VERSION)"
[[ "$expected" =~ ^[0-9a-f]{64}$ ]]
available=false
if [ ! -L "$prefix" ] && [ ! -L "$prefix/.alkane-source-sha256" ] &&
[ -x "$prefix/bin/wx-config" ] &&
[ -s "$prefix/lib/libwx_gtk3u-3.3.a" ] &&
[ "$(cat "$prefix/.alkane-source-sha256" 2>/dev/null || true)" = "$expected" ]; then
available=true
fi
printf 'available=%s\n' "$available" >> "${GITHUB_OUTPUT:?GITHUB_OUTPUT is required}"
+42
View File
@@ -0,0 +1,42 @@
#!/usr/bin/env python3
# SPDX-License-Identifier: MIT
"""Remove generated Toolkit CI work after the release asset is uploaded."""
import os
from pathlib import Path
import shutil
import sys
ROOT = Path(__file__).resolve().parents[1]
DIRECTORIES = ("target", "dist", "coverage", "bench-site")
FILES = ("bench-current.txt",)
def cleanup() -> None:
if not os.environ.get("GITHUB_RUN_ID"):
raise ValueError("cleanup is restricted to CI runs")
for name in DIRECTORIES:
path = ROOT / name
if path.is_symlink() or path.parent.resolve() != ROOT.resolve():
raise ValueError(f"unsafe generated directory: {path}")
if path.is_dir():
shutil.rmtree(path)
print(f"Removed generated directory: {name}")
elif path.exists():
raise ValueError(f"expected a generated directory: {path}")
for name in FILES:
path = ROOT / name
if path.is_symlink() or path.parent.resolve() != ROOT.resolve():
raise ValueError(f"unsafe generated file: {path}")
if path.is_file():
path.unlink()
print(f"Removed generated file: {name}")
if __name__ == "__main__":
try:
cleanup()
except (OSError, ValueError) as error:
print(f"ERROR: Toolkit cleanup: {error}", file=sys.stderr)
raise SystemExit(1)
+15
View File
@@ -0,0 +1,15 @@
#!/usr/bin/env bash
# Convert the next final version into a monotonically numbered prerelease.
set -euo pipefail
result="$(bash ci/compute-version.sh)"
release="$(printf '%s\n' "$result" | sed -n 's/^release=//p')"
if [ "$release" != true ]; then
echo "release=false"
exit 0
fi
version="$(printf '%s\n' "$result" | sed -n 's/^version=//p')"
last="$(git tag -l "v${version}-rc.*" | sed -n "s/^v${version//./\.}-rc\.\([0-9][0-9]*\)$/\1/p" | sort -n | tail -1)"
next=$(( ${last:-0} + 1 ))
echo "release=true"
echo "version=${version}-rc.${next}"
echo "tag=v${version}-rc.${next}"
+1 -1
View File
@@ -18,7 +18,7 @@ X=0
[ -f "$x_file" ] && X=$(tr -dc '0-9' < "$x_file")
X=${X:-0}
last=$(git tag -l 'v*.*.*' | sort -V | tail -1 || true)
last=$(git tag -l 'v*.*.*' | grep -E '^v[0-9]+\.[0-9]+\.[0-9]+$' | sort -V | tail -1 || true)
if [ -n "$last" ]; then
v=${last#v}; lx=${v%%.*}; rest=${v#*.}; ly=${rest%%.*}; lz=${rest##*.}
changed=$(git diff --name-only "$last"..HEAD)
+37
View File
@@ -0,0 +1,37 @@
#!/usr/bin/env bash
# SPDX-License-Identifier: MIT
# Reuse Rust compiler results on persistent CI runners.
set -euo pipefail
[ "$(sccache --version)" = 'sccache 0.18.0' ] || {
echo 'CI image has an unexpected sccache version' >&2
exit 1
}
toolcache="${RUNNER_TOOL_CACHE:-}"
if [ -z "$toolcache" ] || [ -L "$toolcache" ] ||
[ ! -d "$toolcache" ] || [ ! -w "$toolcache" ]; then
echo 'Persistent runner tool cache is unavailable; compiling without sccache'
exit 0
fi
cache_dir="$toolcache/alkane-toolkit-rust-sccache"
if [ -L "$cache_dir" ]; then
echo 'Rust cache path is a symlink' >&2
exit 1
fi
umask 077
mkdir -p "$cache_dir"
if [ ! -d "$cache_dir" ] || [ ! -w "$cache_dir" ]; then
echo 'Rust cache directory is unavailable' >&2
exit 1
fi
chmod 0700 "$cache_dir"
{
printf 'RUSTC_WRAPPER=%s\n' "$(command -v sccache)"
printf 'SCCACHE_DIR=%s\n' "$cache_dir"
printf 'SCCACHE_CACHE_SIZE=2G\n'
printf 'CARGO_INCREMENTAL=0\n'
} >> "${GITHUB_ENV:?GITHUB_ENV is required}"
echo 'Bounded Rust compiler cache configured for Alkane Toolkit'
+16 -13
View File
@@ -2,10 +2,11 @@
# Measure line coverage from BOTH the unit tests AND the headless UI self-test.
#
# The self-test (ALKANE_SELFTEST=1) builds the real wxWidgets table, renders every
# fixture through the real widgets, and checks each cell against the model -- it
# exercises most of ui.rs. Because it runs as a separate binary invocation, a plain
# `cargo llvm-cov` (which only runs the #[test]s) never counts it, so ui.rs shows
# ~4% even though it is integration-tested. This combines both runs' coverage.
# fixture through the real widgets, and checks each cell against the model.
# It covers the fixture-rendering path, while interactive event handlers need
# separate tests. Because it runs as a separate binary invocation, a plain
# `cargo llvm-cov` (which only runs the #[test]s) never counts it. This
# combines both runs' coverage.
#
# Usage: ci/coverage.sh [extra `cargo llvm-cov report` args, e.g. --summary-only]
set -euo pipefail
@@ -16,21 +17,23 @@ export WX_RS_WXCONFIG="${WX_RS_WXCONFIG:-$HOME/.cache/wx-3.3.3-linux/bin/wx-conf
# default; override with CARGO_LLVM_COV_FLAGS if you need something else.
read -ra CARGO_FLAGS <<<"${CARGO_LLVM_COV_FLAGS:---offline}"
# A display for the self-test's real widgets.
need_xvfb() { command -v xvfb-run >/dev/null 2>&1; }
# A display is required for the self-test; skipping it would publish an
# incomplete coverage number as if the measured test set had run.
if ! command -v xvfb-run >/dev/null 2>&1; then
echo "coverage.sh: xvfb-run is required for the UI self-test" >&2
exit 1
fi
cargo llvm-cov clean --workspace
# 1. Unit tests.
# 1. Unit tests for the GUI and all first-party headless crates.
cargo llvm-cov --no-report "${CARGO_FLAGS[@]}" -p alkane-gui --bin alkane-toolkit
cargo llvm-cov --no-report "${CARGO_FLAGS[@]}" \
--workspace --exclude alkane-gui --exclude wx-rs
# 2. Headless UI self-test, under the same instrumentation, its coverage appended.
if need_xvfb; then
xvfb-run -a env GDK_BACKEND=x11 ALKANE_SELFTEST=1 \
cargo llvm-cov run --no-report "${CARGO_FLAGS[@]}" --bin alkane-toolkit
else
echo "coverage.sh: xvfb-run not found; skipping the self-test run (unit tests only)" >&2
fi
xvfb-run -a env GDK_BACKEND=x11 ALKANE_SELFTEST=1 \
cargo llvm-cov run --no-report "${CARGO_FLAGS[@]}" --bin alkane-toolkit
# 3. Merged report, our source only (vendored asic-rs + the patched wx-rs bridge
# are out of scope).
+29
View File
@@ -0,0 +1,29 @@
#!/usr/bin/env bash
# SPDX-License-Identifier: MIT
# Use the preinstalled CI image or install missing packages on older runners.
set -euo pipefail
mode="${1:?usage: ensure-build-deps.sh base|ui|all|ssh}"
case "$mode" in
base) packages=(libssl-dev pkg-config ca-certificates) ;;
ui) packages=(xvfb xauth dbus-x11 fonts-dejavu-core) ;;
ssh) packages=(openssh-client) ;;
all) packages=(libssl-dev pkg-config ca-certificates openssh-client
xvfb xauth dbus-x11 fonts-dejavu-core) ;;
*) echo "unknown dependency set: $mode" >&2; exit 2 ;;
esac
installed="$(dpkg-query -W -f='${Package} ${Status}\n' "${packages[@]}" 2>/dev/null || true)"
missing=()
for package in "${packages[@]}"; do
if ! grep -Fxq "$package install ok installed" <<< "$installed"; then
missing+=("$package")
fi
done
if [ "${#missing[@]}" -eq 0 ]; then
printf 'Build packages already installed: %s\n' "$mode"
exit 0
fi
printf 'Installing %s missing build packages\n' "${#missing[@]}"
apt-get update -qq
DEBIAN_FRONTEND=noninteractive apt-get install -y -qq --no-install-recommends "${packages[@]}"
+43
View File
@@ -0,0 +1,43 @@
#!/usr/bin/env bash
# SPDX-License-Identifier: MIT
# Use the matching image or cache prefix; rebuild after a vendored source bump.
set -euo pipefail
prefix="${WX_PREFIX:?WX_PREFIX is required}"
if [ -L "$prefix" ] || [ -L "$prefix/.alkane-source-sha256" ]; then
echo 'refusing symlinked wxWidgets prefix or source marker' >&2
exit 1
fi
expected="$(awk '$1 == "sha256:" {print $2}' thirdparty/wxwidgets/VERSION)"
[[ "$expected" =~ ^[0-9a-f]{64}$ ]] || {
echo 'invalid pinned wxWidgets source digest' >&2
exit 1
}
marker="$prefix/.alkane-source-sha256"
if [ -e "$marker" ] && [ "$(cat "$marker")" != "$expected" ]; then
python3 - "$prefix" <<'PY'
from pathlib import Path
import shutil
import sys
prefix = Path(sys.argv[1])
allowed = Path('/root/.cache/wx-3.3.3-linux')
if prefix != allowed or prefix.is_symlink():
raise SystemExit('refusing unsafe wxWidgets prefix reset')
if prefix.is_dir():
shutil.rmtree(prefix)
PY
fi
built=false
if [ ! -x "$prefix/bin/wx-config" ] ||
[ ! -s "$prefix/lib/libwx_gtk3u-3.3.a" ]; then
bash scripts/build-wx-linux.sh
built=true
else
echo 'wx prefix available from matching image or cache'
fi
[ -s "$prefix/lib/libwx_gtk3u-3.3.a" ]
printf '%s\n' "$expected" > "$marker"
if [ -n "${GITHUB_OUTPUT:-}" ]; then
printf 'built=%s\n' "$built" >> "$GITHUB_OUTPUT"
fi
+44 -20
View File
@@ -1,10 +1,8 @@
#!/usr/bin/env python3
"""Generate self-contained shields-style SVG badges into badges/.
Self-hosted Gitea renders a README's relative image links straight from the
repo, so committing the SVGs (rather than depending on an external badge
service that would have to reach a possibly-private Gitea) is the robust choice.
CI regenerates them from live metrics and commits any changes back.
Main CI regenerates SVGs from measured metrics and publishes them to the
private ci-badges branch. The README loads those authenticated raw artifacts.
Usage:
gen-badges.py --tests N --coverage PCT --bench "label" [--out badges]
@@ -13,6 +11,7 @@ Metrics not passed on the command line are computed here (LOC from the source
tree, dependency count from Cargo.lock, license from Cargo.toml).
"""
import argparse
import math
import os
import re
import sys
@@ -109,13 +108,13 @@ def loc_color(n: int) -> str:
def bench_color(delta_pct: float) -> str:
# Negative delta = faster than the previous release. A +/-2% dead band absorbs
# the run-to-run jitter of microbenchmarks on a shared CI runner.
if delta_pct <= -2.0:
# Positive delta means faster than the previous release. A +/-2% band
# absorbs run-to-run jitter on the dedicated CI runner.
if delta_pct >= 2.0:
return "brightgreen"
if delta_pct < 2.0:
if delta_pct > -2.0:
return "blue"
if delta_pct < 10.0:
if delta_pct > -10.0:
return "yellow"
return "orange"
@@ -132,10 +131,26 @@ def cov_color(pct: float) -> str:
return "red"
def quality_grade(clippy: str | None) -> str:
if clippy is None:
return "pending"
return "A" if clippy == "clean" else "F"
def human(n: int) -> str:
if n >= 1000:
return f"{n / 1000:.1f}k".replace(".0k", "k")
return str(n)
suffixes = ("", "K", "M", "G")
value = float(n)
index = 0
while value >= 999.5 and index < len(suffixes) - 1:
value /= 1000
index += 1
if value >= 100:
number = f"{value:.0f}"
elif value >= 10:
number = f"{value:.1f}".rstrip("0").rstrip(".")
else:
number = f"{value:.2f}".rstrip("0").rstrip(".")
return number + suffixes[index]
def main() -> int:
@@ -144,13 +159,16 @@ def main() -> int:
ap.add_argument("--root", default=".")
ap.add_argument("--tests", type=int, default=None)
ap.add_argument("--coverage", type=float, default=None)
ap.add_argument("--bench-coverage", type=float, default=None)
ap.add_argument("--bench", default=None)
# Weighted-average microbench delta vs the previous release, as a signed
# percentage string (e.g. "-3.2"), or "NEW"/"" when there is no baseline yet
# (round 19 #1). Takes precedence over --bench for the bench badge.
# Mean per-benchmark improvement vs the previous release, as a signed
# percentage string, or "NEW" when there is no baseline.
ap.add_argument("--bench-delta", default=None)
ap.add_argument("--clippy", default="clean")
ap.add_argument("--clippy", choices=("clean", "failed"))
args = ap.parse_args()
for value in (args.coverage, args.bench_coverage):
if value is not None and (not math.isfinite(value) or not 0 <= value <= 100):
ap.error("coverage must be a finite percentage between 0 and 100")
os.makedirs(os.path.join(args.root, args.out), exist_ok=True)
@@ -167,13 +185,19 @@ def main() -> int:
write("loc", "lines of code", human(loc), loc_color(loc))
write("license", "license", lic, "blue")
write("dependencies", "dependencies", str(deps), "blue")
write("quality", "clippy", args.clippy, "brightgreen" if args.clippy == "clean" else "orange")
grade = quality_grade(args.clippy)
write("quality", "code quality", grade,
{"A": "brightgreen", "B": "yellowgreen", "C": "yellow",
"D": "orange", "F": "red", "pending": "lightgrey"}[grade])
if args.tests is not None:
write("tests", "tests", f"{args.tests} passing", "brightgreen")
if args.coverage is not None:
write("coverage", "coverage", f"{args.coverage:.0f}%", cov_color(args.coverage))
# Bench badge: prefer the weighted-average delta vs the previous release; fall
# back to the static label (first run, or when the delta could not be computed).
write("bench-coverage", "bench coverage",
f"{args.bench_coverage:.0f}%" if args.bench_coverage is not None else "pending",
cov_color(args.bench_coverage) if args.bench_coverage is not None else "lightgrey")
# Bench badge: prefer the mean per-benchmark improvement vs the previous
# release. Use the static label when no comparison is available.
delta = None
if args.bench_delta not in (None, "", "NEW"):
try:
@@ -181,7 +205,7 @@ def main() -> int:
except ValueError:
delta = None
if delta is not None:
# Negative = faster than the previous release (good).
# Positive = faster than the previous release.
msg = f"{'+' if delta > 0 else ''}{delta:.1f}% vs prev"
write("bench", "bench", msg, bench_color(delta))
elif args.bench_delta == "NEW":
+115
View File
@@ -0,0 +1,115 @@
#!/usr/bin/env python3
# SPDX-License-Identifier: MIT
"""Publish the last completed main/next CI result to a private badge branch."""
import base64
import json
import os
from pathlib import Path
from urllib.error import HTTPError
from urllib.parse import quote, urlencode
from urllib.request import Request, urlopen
WORKFLOWS = {"release.yml": "main", "next.yml": "next"}
BADGE_BRANCH = "ci-badges"
def badge(branch: str, conclusion: str, run_id: int) -> bytes:
passed = conclusion == "success"
word = "pass" if passed else "fail"
color = "#2ea043" if passed else "#d1242f"
title = f"CI {branch}: last completed attempt {word} (run {run_id})"
return (f'<svg xmlns="http://www.w3.org/2000/svg" width="102" height="20" '
f'role="img" aria-label="{title}"><title>{title}</title>'
'<rect width="102" height="20" rx="3" fill="#555"/>'
f'<path d="M39 0h60a3 3 0 0 1 3 3v14a3 3 0 0 1-3 3H39z" fill="{color}"/>'
'<text x="20" y="14" fill="#fff" text-anchor="middle" '
'font-family="sans-serif" font-size="11">CI</text>'
f'<text x="70" y="14" fill="#fff" text-anchor="middle" '
f'font-family="sans-serif" font-size="11">{word}</text></svg>\n').encode()
def request_json(url: str, token: str, method: str = "GET",
payload: dict | None = None) -> dict:
body = None if payload is None else json.dumps(payload).encode()
request = Request(url, data=body, method=method,
headers={"Authorization": f"token {token}",
"Content-Type": "application/json"})
with urlopen(request, timeout=20) as response:
return json.load(response)
def latest_completed(api: str, repo: str, workflow: str, branch: str,
token: str) -> tuple[int, str]:
path = quote(workflow, safe="")
latest = None
for page in range(1, 21):
query = urlencode({"branch": branch, "limit": 50, "page": page})
url = f"{api}/repos/{repo}/actions/workflows/{path}/runs?{query}"
runs = request_json(url, token).get("workflow_runs", [])
for run in runs:
if run.get("head_branch") != branch or run.get("status") != "completed":
continue
if run.get("conclusion") not in ("success", "failure"):
continue
candidate = (int(run["id"]), run["conclusion"])
if latest is None or candidate[0] > latest[0]:
latest = candidate
if len(runs) < 50:
break
if latest is None:
raise RuntimeError(f"no completed {branch} run found for {workflow}")
return latest
def publish(api: str, repo: str, branch: str, data: bytes, token: str) -> None:
path = f"{api}/repos/{repo}/contents/{branch}.svg"
encoded = base64.b64encode(data).decode("ascii")
for attempt in range(3):
try:
current = request_json(path + "?ref=" + BADGE_BRANCH, token)
current_data = base64.b64decode(current["content"])
if current_data == data:
return
sha = current["sha"]
method = "PUT"
except HTTPError as error:
if error.code != 404:
raise
sha = None
method = "POST"
payload = {"branch": BADGE_BRANCH, "content": encoded,
"message": f"Record completed {branch} CI attempt"}
if sha is not None:
payload["sha"] = sha
try:
request_json(path, token, method, payload)
return
except HTTPError as error:
if error.code not in (409, 422) or attempt == 2:
raise
raise RuntimeError("badge write did not complete")
def main() -> None:
event = json.loads(Path(os.environ["GITHUB_EVENT_PATH"]).read_text())
if event.get("action") != "completed":
raise RuntimeError("expected a completed workflow_run event")
run = event["workflow_run"]
workflow = run["path"].split("@", 1)[0].rsplit("/", 1)[-1]
expected_branch = WORKFLOWS.get(workflow)
if expected_branch is None or run.get("head_branch") != expected_branch:
raise RuntimeError("unexpected workflow or branch")
repo = os.environ["GITHUB_REPOSITORY"]
if event["repository"]["full_name"] != repo:
raise RuntimeError("repository mismatch")
api = os.environ["GITHUB_API_URL"].rstrip("/")
token = os.environ["GITEA_TOKEN"]
run_id, conclusion = latest_completed(api, repo, workflow, expected_branch, token)
publish(api, repo, expected_branch, badge(expected_branch, conclusion, run_id), token)
print(f"{expected_branch} badge records completed run {run_id}: {conclusion}")
if __name__ == "__main__":
main()
+110
View File
@@ -0,0 +1,110 @@
#!/usr/bin/env python3
# SPDX-License-Identifier: MIT
"""Classify a pull request for scoped CI checks."""
import os
from pathlib import Path
import subprocess
import sys
import tomllib
ROOT = Path(__file__).resolve().parents[1]
DOC_FILES = {"README.md", "CONTRIBUTING.md", "CHANGELOG.md"}
HEADLESS_CRATES = {"alkane-access", "alkane-artifacts", "alkane-cli", "alkane-flash"}
def documentation_only(paths: list[str]) -> bool:
return bool(paths) and all(
path in DOC_FILES or
(path.startswith("docs/") and Path(path).suffix in {".md", ".txt"})
for path in paths
)
def headless_packages(paths: list[str]) -> list[str]:
"""Return tested reverse dependents for code outside the GUI graph."""
changed: set[str] = set()
if not paths:
return []
for path in paths:
parts = Path(path).parts
if (len(parts) < 4 or parts[0] != "crates" or
parts[1] not in HEADLESS_CRATES or
parts[2] not in {"src", "tests"} or
Path(path).suffix != ".rs"):
return []
changed.add(parts[1])
try:
manifests = {}
for path in (ROOT / "crates").glob("*/Cargo.toml"):
manifest = tomllib.loads(path.read_text())
name = manifest["package"]["name"]
if name != path.parent.name:
return []
manifests[name] = manifest
if not changed <= manifests.keys() or "alkane-gui" not in manifests:
return []
def dependencies(value: object) -> set[str]:
found: set[str] = set()
if isinstance(value, dict):
for key, nested in value.items():
if key in {"dependencies", "dev-dependencies", "build-dependencies"}:
for dep_name, spec in nested.items():
found.add(spec.get("package", dep_name) if isinstance(spec, dict)
else dep_name)
else:
found.update(dependencies(nested))
return found & manifests.keys()
graph = {name: dependencies(manifest) for name, manifest in manifests.items()}
affected = changed.copy()
while True:
added = {name for name, deps in graph.items() if deps & affected} - affected
if not added:
break
affected.update(added)
return [] if "alkane-gui" in affected else sorted(affected)
except (OSError, KeyError, TypeError, ValueError):
return []
def changed_paths() -> list[str]:
if os.environ.get("GITHUB_EVENT_NAME") != "pull_request":
raise ValueError("not a pull request")
if os.environ.get("GITHUB_BASE_REF") != "main":
raise ValueError("unknown base branch")
merge_base = subprocess.check_output(
["git", "-C", str(ROOT), "merge-base", "HEAD",
"refs/remotes/origin/main"],
stderr=subprocess.DEVNULL, text=True,
).strip()
if len(merge_base) != 40:
raise ValueError("missing merge base")
raw = subprocess.check_output(
["git", "-C", str(ROOT), "diff", "--no-renames", "--name-only", "-z",
merge_base, "HEAD"], stderr=subprocess.DEVNULL,
)
return [path.decode("utf-8", "surrogateescape")
for path in raw.split(b"\0") if path]
def main() -> None:
try:
paths = changed_paths()
docs = documentation_only(paths)
packages = headless_packages(paths) if not docs else []
except (OSError, subprocess.CalledProcessError, ValueError):
paths = []
docs = False
packages = []
surface = "documentation" if docs else "headless" if packages else "full"
print(f"surface={surface}")
print(f"packages={' '.join(packages)}")
print(f"Changed paths: {len(paths)}", file=sys.stderr)
if __name__ == "__main__":
main()
+121
View File
@@ -0,0 +1,121 @@
#!/usr/bin/env python3
# SPDX-License-Identifier: MIT
"""Publish a measured benchmark page to the public, data-only Pages repo."""
import argparse
import json
import os
from pathlib import Path
import shlex
import subprocess
import tempfile
from urllib.request import Request, urlopen
PAGES_REPO = "ssh://git@gitea.bluefla.re:2222/blueflare/alkane-benchmarks.git"
GUARD_REPO = "https://gitea.bluefla.re/blueflare/alkane-benchmarks.git"
GUARD_COMMIT = "ea160545c49bc419a245692deda8dd7db7a611eb"
PAGES_HOST = "gitea.bluefla.re"
PAGES_HOST_FINGERPRINT = "SHA256:lqB5cmC9E5HNeg/lkzdOwQ++I8A70Wx7lnNs6liN24g"
PAGES_HOST_KEY = "[gitea.bluefla.re]:2222 ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIO1II6NkmRW+QAd+Wj+7qbNrA8Oo+/N/WRog4hELskn/"
def run(*args: str, env: dict[str, str] | None = None,
cwd: Path | None = None) -> subprocess.CompletedProcess[str]:
return subprocess.run(args, env=env, cwd=cwd, text=True,
capture_output=True, check=True)
def current_main_sha() -> str:
api = os.environ["GITHUB_API_URL"].rstrip("/")
repo = os.environ["GITHUB_REPOSITORY"]
token = os.environ["GITEA_TOKEN"]
request = Request(f"{api}/repos/{repo}/branches/main",
headers={"Authorization": f"token {token}"})
with urlopen(request, timeout=20) as response:
branch = json.load(response)
return branch["commit"]["id"]
def publish(site: str) -> None:
if os.environ.get("GITHUB_REF") != "refs/heads/main":
raise ValueError("benchmark Pages publication requires main")
sha = os.environ["GITHUB_SHA"]
if current_main_sha() != sha:
print("Skipping benchmark page from a superseded main commit")
return
page = Path("bench-site/index.html").read_bytes()
if not page.startswith(b"<!doctype html>") or len(page) > 1_048_576:
raise ValueError("invalid benchmark page")
with tempfile.TemporaryDirectory(prefix="alkane-pages-") as directory:
temporary = Path(directory)
guard_checkout = temporary / "guard"
run("git", "clone", "--quiet", "--single-branch", "--branch", "next",
GUARD_REPO, str(guard_checkout))
guard_source = run("git", "show", f"{GUARD_COMMIT}:ci/validate_site.py",
cwd=guard_checkout).stdout
guard_script = temporary / "validate_site.py"
guard_script.write_text(guard_source)
run("python3", str(guard_script), "--page", site,
str(Path("bench-site/index.html").resolve()))
key = os.environ["BENCH_PAGES_DEPLOY_KEY"]
if not key.startswith("-----BEGIN OPENSSH PRIVATE KEY-----"):
raise ValueError("missing benchmark Pages deploy key")
key_path = temporary / "deploy_key"
key_path.write_text(key.rstrip("\n") + "\n")
key_path.chmod(0o600)
known_hosts = temporary / "known_hosts"
known_hosts.write_text(PAGES_HOST_KEY + "\n")
fingerprint = run("ssh-keygen", "-lf", str(known_hosts)).stdout.split()[1]
if fingerprint != PAGES_HOST_FINGERPRINT:
raise ValueError("benchmark Pages SSH host key changed")
git_env = os.environ.copy()
ssh_command = (f"ssh -i {shlex.quote(str(key_path))} -o IdentitiesOnly=yes "
f"-o UserKnownHostsFile={shlex.quote(str(known_hosts))} "
"-o StrictHostKeyChecking=yes -o ConnectTimeout=10")
git_env["GIT_SSH_COMMAND"] = ssh_command
git_env["GIT_TERMINAL_PROMPT"] = "0"
checkout = temporary / "site"
run("git", "clone", "--quiet", "--single-branch", "--branch", "gh-pages",
PAGES_REPO, str(checkout), env=git_env)
run("git", "config", "user.name", "Alkane CI", cwd=checkout)
run("git", "config", "user.email", "ci@bluefla.re", cwd=checkout)
for attempt in range(3):
if current_main_sha() != sha:
print("Skipping benchmark page from a superseded main commit")
return
run("git", "fetch", "--quiet", "origin", "gh-pages", env=git_env,
cwd=checkout)
run("git", "checkout", "-q", "-B", "bench-publish", "origin/gh-pages",
cwd=checkout)
destination = checkout / site / "index.html"
destination.parent.mkdir(exist_ok=True)
destination.write_bytes(page)
run("git", "add", f"{site}/index.html", cwd=checkout)
changed = subprocess.run(("git", "diff", "--cached", "--quiet"),
cwd=checkout, check=False)
if changed.returncode == 0:
print(f"{site} benchmark page is already current")
return
if changed.returncode != 1:
raise RuntimeError("cannot compare benchmark page")
run("git", "commit", "-q", "-m",
f"Update {site} benchmarks for {sha[:10]} [skip ci]", cwd=checkout)
pushed = subprocess.run(("git", "push", "--quiet", "origin",
"HEAD:gh-pages"), env=git_env, cwd=checkout,
text=True, capture_output=True, check=False)
if pushed.returncode == 0:
print(f"Published {site} benchmark page for {sha[:10]}")
return
if attempt == 2:
raise RuntimeError(f"benchmark Pages push failed: {pushed.stderr.strip()}")
raise RuntimeError("benchmark Pages publication did not complete")
def main() -> None:
parser = argparse.ArgumentParser()
parser.add_argument("site", choices=("sdk", "os", "toolkit"))
publish(parser.parse_args().site)
if __name__ == "__main__":
main()
+29
View File
@@ -0,0 +1,29 @@
#!/usr/bin/env python3
# SPDX-License-Identifier: MIT
"""Publish measured toolkit badges to the private Gitea badge branch."""
import os
from pathlib import Path
from badge_store import publish_file
ROOT = Path(__file__).resolve().parents[1]
NAMES = ("tests", "coverage", "bench", "bench-coverage", "loc",
"dependencies", "quality", "license")
def main() -> None:
api = os.environ["GITHUB_API_URL"].rstrip("/")
repo = os.environ["GITHUB_REPOSITORY"]
token = os.environ["GITEA_TOKEN"]
for name in NAMES:
data = (ROOT / "badges" / f"{name}.svg").read_bytes()
if not data.lstrip().startswith(b"<svg"):
raise ValueError(f"invalid {name} SVG")
publish_file(api, repo, f"badges/{name}.svg", data, token,
f"Update measured {name} badge")
print(f"Published {len(NAMES)} measured badge SVGs")
if __name__ == "__main__":
main()
+56
View File
@@ -0,0 +1,56 @@
#!/usr/bin/env python3
# SPDX-License-Identifier: MIT
"""Create one Gitea release and attach files using the runner's scoped token."""
import json
import os
import pathlib
import sys
import urllib.error
import urllib.parse
import urllib.request
def request(url, payload, content_type):
headers = {
"Authorization": "token " + os.environ["GITEA_TOKEN"],
"Content-Type": content_type,
}
req = urllib.request.Request(url, data=payload, headers=headers, method="POST")
with urllib.request.urlopen(req, timeout=60) as response:
return json.load(response)
def main():
if len(sys.argv) < 4:
sys.exit("usage: release.py TAG PRERELEASE FILE [FILE ...]")
tag, prerelease, *files = sys.argv[1:]
api = os.environ.get("GITHUB_API_URL", "https://gitea.bluefla.re/api/v1").rstrip("/")
repo = os.environ["GITHUB_REPOSITORY"]
sha = os.environ["GITHUB_SHA"]
body = f"Automated Alkane toolkit build from {sha}."
metadata = {
"tag_name": tag,
"target_commitish": sha,
"name": tag,
"body": body,
"prerelease": prerelease.lower() == "true",
}
try:
release = request(f"{api}/repos/{repo}/releases", json.dumps(metadata).encode(), "application/json")
except urllib.error.HTTPError as exc:
sys.exit(f"release creation failed: HTTP {exc.code}")
release_id = release["id"]
for name in files:
path = pathlib.Path(name)
query = urllib.parse.urlencode({"name": path.name})
try:
request(f"{api}/repos/{repo}/releases/{release_id}/assets?{query}",
path.read_bytes(), "application/octet-stream")
except urllib.error.HTTPError as exc:
sys.exit(f"asset upload failed for {path.name}: HTTP {exc.code}")
print(f"Created {tag} with {len(files)} assets")
if __name__ == "__main__":
main()
+1
View File
@@ -0,0 +1 @@
gitea.bluefla.re/blueflare/alkane-ci@sha256:9d2a992bbcb91014af3c85d2e1ec8c5990701cecf83fd06c8d46f9ef13dbd948
+55
View File
@@ -0,0 +1,55 @@
#!/usr/bin/env python3
# SPDX-License-Identifier: MIT
"""Check that every Toolkit benchmark contributes to the release badge."""
import importlib.util
import re
from pathlib import Path
import unittest
ROOT = Path(__file__).resolve().parents[1]
spec = importlib.util.spec_from_file_location("bench_badge", ROOT / "ci/bench-badge.py")
assert spec is not None and spec.loader is not None
badge = importlib.util.module_from_spec(spec)
spec.loader.exec_module(badge)
badge_spec = importlib.util.spec_from_file_location("gen_badges", ROOT / "ci/gen-badges.py")
assert badge_spec is not None and badge_spec.loader is not None
gen_badges = importlib.util.module_from_spec(badge_spec)
badge_spec.loader.exec_module(gen_badges)
class BenchBadgeTests(unittest.TestCase):
def test_declared_suite_matches_rust_benchmarks(self):
names = set()
for directory in (ROOT / "crates/alkane-gui/src", ROOT / "crates/alkane-artifacts/src"):
for path in directory.rglob("*.rs"):
names.update(re.findall(
r'#\[test\]\s*#\[ignore(?:\s*=\s*"[^"]*")?\]\s*'
r'fn (bench_[A-Za-z0-9_]+)\s*\(', path.read_text()))
self.assertEqual(names, badge.EXPECTED_BENCHES)
def test_incomplete_duplicate_and_malformed_results_fail(self):
lines = [f"test tests::{name} ... {name}: 10ms/op"
for name in sorted(badge.EXPECTED_BENCHES)]
values = badge.require_suite(badge.parse_bench("\n".join(lines)))
self.assertEqual(len(values), 12)
with self.assertRaisesRegex(ValueError, "declared suite"):
badge.require_suite(badge.parse_bench("\n".join(lines[:-1])))
with self.assertRaisesRegex(ValueError, "duplicate"):
badge.parse_bench("\n".join(lines + [lines[0]]))
with self.assertRaisesRegex(ValueError, "missing timing"):
badge.parse_bench(lines[0].replace("10ms/op", "missing"))
def test_badge_averages_each_benchmark_improvement(self):
current = {"short": 50.0, "long": 900.0}
baseline = {"short": 100.0, "long": 1000.0}
self.assertEqual(badge.benchmark_delta(current, baseline), 30.0)
self.assertAlmostEqual(badge.benchmark_delta(baseline, current), -55.5555556)
self.assertIsNone(badge.benchmark_delta(current, {}))
self.assertEqual(gen_badges.bench_color(30.0), "brightgreen")
self.assertEqual(gen_badges.bench_color(-55.5555556), "orange")
if __name__ == "__main__":
unittest.main()
+70
View File
@@ -0,0 +1,70 @@
#!/usr/bin/env python3
# SPDX-License-Identifier: MIT
"""Exercise benchmark history selection and safe site rendering."""
import sys
from pathlib import Path
import unittest
sys.path.insert(0, str(Path(__file__).resolve().parent))
from bench_history import bench_badge, previous_measurement, render_html, updated_index
class HistoryTests(unittest.TestCase):
def test_cargo_nocapture_benchmark_lines_are_parsed(self):
output = (
"test tests::bench_verify_artifact ... bench_verify_artifact: 208.302µs\n"
"test model::tests::bench_render_cells ... bench_render_cells: "
"5000 rows x 10 cols = 8.007185ms/full-render (bytes=13553600)\n"
"bench_direct: 12ns/op\n"
)
self.assertEqual(bench_badge.parse_bench(output), {
"bench_verify_artifact": 208_302.0,
"bench_render_cells": 8_007_185.0,
"bench_direct": 12.0,
})
def test_retry_uses_previous_commit(self):
first = "a" * 40
second = "b" * 40
index = {"schema": 1, "entries": [
{"sha": first, "timestamp": "2026-01-01T00:00:00+00:00",
"metrics": {"bench_ns_per_op": {"hash": 10.0}}},
{"sha": second, "timestamp": "2026-01-02T00:00:00+00:00",
"metrics": {"bench_ns_per_op": {"hash": 8.0}}}]}
self.assertEqual(previous_measurement(index, second,
lambda ancestor, sha: 1 if ancestor == first else None),
{"hash": 10.0})
updated = updated_index(index, second, {"bench_ns_per_op": {"hash": 7.5}},
"2026-01-03T00:00:00+00:00")
self.assertEqual(len(updated["entries"]), 2)
self.assertEqual(updated["entries"][-1]["metrics"]["bench_ns_per_op"]["hash"], 7.5)
def test_invalid_measurement_and_sha_rejected(self):
with self.assertRaises(ValueError):
updated_index({}, "bad", {"bench_ns_per_op": {"hash": 1}}, "now")
with self.assertRaises(ValueError):
updated_index({}, "a" * 40, {"bench_ns_per_op": {"hash": -1}}, "now")
def test_baseline_must_match_cpu_class(self):
host = {"architecture": "x86_64", "cpu_model": "A", "logical_cpus": 8}
other = {"architecture": "x86_64", "cpu_model": "B", "logical_cpus": 8}
index = {"entries": [{"sha": "a" * 40, "metrics": {
"bench_ns_per_op": {"hash": 10.0}, "bench_host": host}}]}
distance = lambda _ancestor, _sha: 1
self.assertEqual(previous_measurement(index, "b" * 40, distance, host),
{"hash": 10.0})
self.assertEqual(previous_measurement(index, "b" * 40, distance, other), {})
def test_site_escapes_history_content(self):
entry = {"sha": "a" * 40, "timestamp": "<script>alert(1)</script>",
"metrics": {"bench_ns_per_op": {"hash": 10.0},
"bench_host": {"cpu_model": "<script>cpu</script>"}}}
page = render_html({"entries": [entry]})
self.assertIn("&lt;script&gt;", page)
self.assertNotIn("<script>", page)
self.assertIn("10.000", page)
if __name__ == "__main__":
unittest.main()
+35
View File
@@ -0,0 +1,35 @@
#!/usr/bin/env python3
# SPDX-License-Identifier: MIT
"""Check that queued CI runs do not displace the last completed result."""
import importlib.util
from pathlib import Path
from unittest.mock import patch
import xml.etree.ElementTree as ET
path = Path(__file__).with_name("last-attempt-badge.py")
spec = importlib.util.spec_from_file_location("last_attempt_badge", path)
module = importlib.util.module_from_spec(spec)
spec.loader.exec_module(module)
def runs(_url, _token):
return {"workflow_runs": [
{"id": 105, "head_branch": "main", "status": "completed", "conclusion": "cancelled"},
{"id": 104, "head_branch": "main", "status": "queued", "conclusion": None},
{"id": 103, "head_branch": "main", "status": "completed", "conclusion": "failure"},
{"id": 102, "head_branch": "main", "status": "completed", "conclusion": "success"},
]}
with patch.object(module, "request_json", runs):
assert module.latest_completed("https://example.invalid/api/v1", "owner/repo",
"release.yml", "main", "token") == (103, "failure")
svg = module.badge("main", "failure", 103)
root = ET.fromstring(svg)
assert root.attrib["aria-label"] == "CI main: last completed attempt fail (run 103)"
assert b">fail</text>" in svg
assert b"#d1242f" in svg
assert b">pass</text>" in module.badge("next", "success", 108)
print("last completed CI badge: queued run ignored, pass/fail SVGs valid")
+112
View File
@@ -0,0 +1,112 @@
#!/usr/bin/env python3
# SPDX-License-Identifier: MIT
"""Check that unknown changes cannot take a scoped CI path."""
import os
from pathlib import Path
import subprocess
import tempfile
import importlib.util
SCRIPT = Path(__file__).with_name("pr-surface.py")
spec = importlib.util.spec_from_file_location("pr_surface", SCRIPT)
assert spec and spec.loader
pr_surface = importlib.util.module_from_spec(spec)
spec.loader.exec_module(pr_surface)
def git(directory: Path, *args: str) -> str:
return subprocess.check_output(
["git", "-C", str(directory), *args], text=True,
stderr=subprocess.DEVNULL,
).strip()
def main() -> None:
assert pr_surface.documentation_only(["README.md", "docs/setup.md"])
for paths in ([], ["docs/generated.json"], ["src/main.rs"],
["README.md", "ci/pr-surface.py"]):
assert not pr_surface.documentation_only(paths), paths
assert pr_surface.headless_packages(["crates/alkane-cli/src/main.rs"]) == ["alkane-cli"]
assert pr_surface.headless_packages(["crates/alkane-artifacts/src/lib.rs"]) == [
"alkane-artifacts", "alkane-cli", "alkane-flash",
]
assert pr_surface.headless_packages([
"crates/alkane-access/src/lib.rs", "crates/alkane-flash/tests/update.rs",
]) == ["alkane-access", "alkane-flash"]
for paths in ([], ["crates/alkane-core/src/lib.rs"],
["crates/alkane-discovery/src/lib.rs"],
["crates/alkane-gui/src/main.rs"],
["crates/alkane-artifacts/Cargo.toml"],
["crates/alkane-cli/src/main.rs", "Cargo.lock"],
["crates/alkane-cli/src/main.rs", "ci/pr-surface.py"],
["crates/alkane-cli/README.md"]):
assert pr_surface.headless_packages(paths) == [], paths
with tempfile.TemporaryDirectory(prefix="alkane-toolkit-graph-") as directory:
root = Path(directory)
for name, extra in (
("alkane-gui", ""),
("alkane-artifacts", ""),
("alkane-flash", 'alkane-artifacts = { path = "../alkane-artifacts" }\n'),
):
crate = root / "crates" / name
crate.mkdir(parents=True)
(crate / "Cargo.toml").write_text(
f'[package]\nname = "{name}"\nversion = "0.1.0"\n'
f'[dependencies]\n{extra}'
)
saved_root = pr_surface.ROOT
try:
pr_surface.ROOT = root
changed = ["crates/alkane-artifacts/src/lib.rs"]
assert pr_surface.headless_packages(changed) == [
"alkane-artifacts", "alkane-flash",
]
with (root / "crates/alkane-gui/Cargo.toml").open("a") as stream:
stream.write('alkane-flash = { path = "../alkane-flash" }\n')
assert pr_surface.headless_packages(changed) == []
finally:
pr_surface.ROOT = saved_root
with tempfile.TemporaryDirectory(prefix="alkane-toolkit-pr-surface-") as directory:
repo = Path(directory)
git(repo, "init", "-q")
git(repo, "config", "user.name", "CI Test")
git(repo, "config", "user.email", "ci@example.invalid")
(repo / "README.md").write_text("initial\n")
git(repo, "add", "README.md")
git(repo, "commit", "-qm", "base")
base = git(repo, "rev-parse", "HEAD")
git(repo, "update-ref", "refs/remotes/origin/main", base)
(repo / "README.md").write_text("documentation change\n")
git(repo, "commit", "-qam", "docs")
saved_root = pr_surface.ROOT
saved_env = dict(os.environ)
try:
pr_surface.ROOT = repo
os.environ["GITHUB_EVENT_NAME"] = "pull_request"
os.environ["GITHUB_BASE_REF"] = "main"
assert pr_surface.changed_paths() == ["README.md"]
git(repo, "checkout", "-q", "-b", "rename-check", base)
git(repo, "mv", "README.md", "code.rs")
git(repo, "commit", "-qm", "rename")
assert set(pr_surface.changed_paths()) == {"README.md", "code.rs"}
os.environ.pop("GITHUB_BASE_REF")
try:
pr_surface.changed_paths()
except ValueError:
pass
else:
raise AssertionError("missing base must fall back to full checks")
finally:
pr_surface.ROOT = saved_root
os.environ.clear()
os.environ.update(saved_env)
print("Toolkit PR change surface: documentation, headless, and fallback PASS")
if __name__ == "__main__":
main()
+25
View File
@@ -0,0 +1,25 @@
#!/usr/bin/env bash
# SPDX-License-Identifier: MIT
# Key the native wxWidgets prefix to its tracked source and build toolchain.
set -euo pipefail
material="$({
git rev-parse HEAD:thirdparty/wxwidgets/wxWidgets-3.3.3
git rev-parse HEAD:scripts/build-wx-linux.sh
cat thirdparty/wx-rs/VERSION
gcc -dumpmachine
gcc -dumpfullversion
pkg-config --modversion gtk+-3.0
mapfile -t modules < <(pkg-config --list-all | awk '{print $1}' | LC_ALL=C sort -u)
for module in "${modules[@]}"; do
printf '%s=%s\n' "$module" "$(pkg-config --modversion "$module" 2>/dev/null || printf unavailable)"
done
getconf GNU_LIBC_VERSION
} )"
digest="$(printf '%s\n' "$material" | sha256sum | cut -c1-24)"
key="wx-3.3.3-$digest"
if [ -n "${GITHUB_OUTPUT:-}" ]; then
printf 'key=%s\n' "$key" >> "$GITHUB_OUTPUT"
else
printf '%s\n' "$key"
fi
+219 -1
View File
@@ -1 +1,219 @@
// alkane-access
// SPDX-License-Identifier: MIT
//! Bounded, read-only SSH probes for board identification.
use std::fs;
use std::io::{self, Read};
use std::net::IpAddr;
use std::path::{Path, PathBuf};
use std::process::{Command, Stdio};
use std::thread;
use std::time::{Duration, Instant};
const MAX_PROBE_BYTES: usize = 64 * 1024;
const PROBE_TIMEOUT: Duration = Duration::from_secs(12);
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum Probe {
KernelRelease,
MtdTable,
DeviceTreeModel,
}
impl Probe {
fn command(self) -> &'static str {
match self {
Self::KernelRelease => "uname -r",
Self::MtdTable => "cat /proc/mtd",
Self::DeviceTreeModel => "cat /proc/device-tree/model",
}
}
}
#[derive(Debug)]
pub enum AccessError {
InvalidTarget,
InvalidKnownHosts,
Timeout,
OutputTooLarge,
RemoteFailure,
Io(io::Error),
}
impl From<io::Error> for AccessError {
fn from(error: io::Error) -> Self {
Self::Io(error)
}
}
pub struct SshTarget {
address: IpAddr,
port: u16,
user: String,
known_hosts: PathBuf,
}
impl SshTarget {
pub fn new(
address: IpAddr,
port: u16,
user: &str,
known_hosts: &Path,
) -> Result<Self, AccessError> {
if port == 0
|| user.is_empty()
|| !user
.bytes()
.all(|byte| byte.is_ascii_alphanumeric() || matches!(byte, b'_' | b'-' | b'.'))
{
return Err(AccessError::InvalidTarget);
}
if !known_hosts.is_absolute()
|| !fs::metadata(known_hosts).is_ok_and(|metadata| metadata.is_file())
{
return Err(AccessError::InvalidKnownHosts);
}
Ok(Self {
address,
port,
user: user.to_owned(),
known_hosts: known_hosts.to_owned(),
})
}
fn command(&self, probe: Probe) -> Command {
let mut command = Command::new("ssh");
command
.arg("-F")
.arg("none")
.arg("-o")
.arg("BatchMode=yes")
.arg("-o")
.arg("StrictHostKeyChecking=yes")
.arg("-o")
.arg("GlobalKnownHostsFile=none")
.arg("-o")
.arg(format!("UserKnownHostsFile={}", self.known_hosts.display()))
.arg("-o")
.arg("ConnectTimeout=5")
.arg("-o")
.arg("ServerAliveInterval=5")
.arg("-o")
.arg("ServerAliveCountMax=1")
.arg("-o")
.arg("RequestTTY=no")
.arg("-p")
.arg(self.port.to_string())
.arg(format!("{}@{}", self.user, self.address))
.arg(probe.command());
command
}
pub fn probe(&self, probe: Probe) -> Result<Vec<u8>, AccessError> {
run_bounded(self.command(probe))
}
}
fn collect_bounded<R: Read + Send + 'static>(
mut reader: R,
) -> thread::JoinHandle<Result<Vec<u8>, AccessError>> {
thread::spawn(move || {
let mut data = Vec::new();
let mut chunk = [0_u8; 4096];
loop {
let count = reader.read(&mut chunk)?;
if count == 0 {
return Ok(data);
}
if data.len() + count > MAX_PROBE_BYTES {
return Err(AccessError::OutputTooLarge);
}
data.extend_from_slice(&chunk[..count]);
}
})
}
fn run_bounded(command: Command) -> Result<Vec<u8>, AccessError> {
run_bounded_with_timeout(command, PROBE_TIMEOUT)
}
fn run_bounded_with_timeout(
mut command: Command,
timeout: Duration,
) -> Result<Vec<u8>, AccessError> {
command
.stdin(Stdio::null())
.stdout(Stdio::piped())
.stderr(Stdio::piped());
let mut child = command.spawn()?;
let stdout = collect_bounded(child.stdout.take().expect("piped stdout"));
let stderr = collect_bounded(child.stderr.take().expect("piped stderr"));
let deadline = Instant::now() + timeout;
let result = loop {
if let Some(status) = child.try_wait()? {
break status.success();
}
if Instant::now() >= deadline {
let _ = child.kill();
let _ = child.wait();
let _ = stdout.join();
let _ = stderr.join();
return Err(AccessError::Timeout);
}
thread::sleep(Duration::from_millis(10));
};
let output = stdout.join().map_err(|_| AccessError::RemoteFailure)??;
let error_output = stderr.join().map_err(|_| AccessError::RemoteFailure)??;
if !result || !error_output.is_empty() {
return Err(AccessError::RemoteFailure);
}
Ok(output)
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn target_rejects_injected_user_and_unknown_host_file() {
let address = "127.0.0.1".parse().unwrap();
assert!(matches!(
SshTarget::new(
address,
22,
"root;id",
Path::new("/etc/ssh/ssh_known_hosts")
),
Err(AccessError::InvalidTarget)
));
assert!(matches!(
SshTarget::new(address, 22, "root", Path::new("relative-known-hosts")),
Err(AccessError::InvalidKnownHosts)
));
}
#[cfg(unix)]
#[test]
fn bounded_runner_rejects_excess_output_and_failed_command() {
let mut success = Command::new("/bin/sh");
success.args(["-c", "printf board"]);
assert_eq!(run_bounded(success).unwrap(), b"board");
let mut overflow = Command::new("/bin/sh");
overflow.args(["-c", "head -c 70000 /dev/zero"]);
assert!(matches!(
run_bounded(overflow),
Err(AccessError::OutputTooLarge)
));
let mut failed = Command::new("/bin/sh");
failed.args(["-c", "exit 7"]);
assert!(matches!(
run_bounded(failed),
Err(AccessError::RemoteFailure)
));
let mut hanging = Command::new("/bin/sleep");
hanging.arg("1");
assert!(matches!(
run_bounded_with_timeout(hanging, Duration::from_millis(20)),
Err(AccessError::Timeout)
));
}
}
+2
View File
@@ -6,3 +6,5 @@ license.workspace = true
[dependencies]
alkane-core = { path = "../alkane-core" }
sha2.workspace = true
thiserror.workspace = true
+257 -1
View File
@@ -1 +1,257 @@
// alkane-artifacts
// SPDX-License-Identifier: MIT
//! Verify local firmware artifacts before an install path consumes them.
use sha2::{Digest, Sha256};
use std::collections::HashSet;
use std::fs::File;
use std::io::{Read, Seek, SeekFrom};
use std::path::{Component, Path, PathBuf};
use thiserror::Error;
const SEED: &str = include_str!("../data/manifest-seed.csv");
const HEADER: &str = "sha256,size_bytes,path,family,format,applicability";
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct ArtifactRecord {
pub sha256: String,
pub size_bytes: u64,
pub path: PathBuf,
pub family: String,
pub format: String,
pub applicability: String,
}
#[derive(Debug, Error)]
pub enum VerifyError {
#[error("artifact I/O: {0}")]
Io(#[from] std::io::Error),
#[error("manifest line {0} is invalid")]
Manifest(usize),
#[error("artifact size differs from manifest")]
Size,
#[error("artifact signature does not match its declared format")]
Signature,
#[error("artifact SHA-256 differs from manifest")]
Digest,
#[error("artifact format is not recognized")]
UnsupportedFormat,
}
/// A verified, rewound descriptor. Consumers should read this descriptor
/// directly instead of reopening the path after verification.
pub struct VerifiedArtifact {
file: File,
record: ArtifactRecord,
}
impl VerifiedArtifact {
pub fn record(&self) -> &ArtifactRecord {
&self.record
}
pub fn reader(&mut self) -> &mut File {
&mut self.file
}
/// Recheck the same descriptor immediately before a guarded write.
pub fn revalidate(&mut self) -> Result<(), VerifyError> {
verify_open_file(&mut self.file, &self.record)
}
}
pub fn seed_manifest() -> Result<Vec<ArtifactRecord>, VerifyError> {
parse_manifest(SEED)
}
pub fn parse_manifest(text: &str) -> Result<Vec<ArtifactRecord>, VerifyError> {
let mut lines = text.lines();
if lines.next() != Some(HEADER) {
return Err(VerifyError::Manifest(1));
}
let mut paths = HashSet::new();
let mut records = Vec::new();
for (line_number, line) in lines.enumerate() {
let line_number = line_number + 2;
let parts: Vec<_> = line.splitn(6, ',').collect();
if parts.len() != 6 || parts.iter().any(|part| part.trim().is_empty()) {
return Err(VerifyError::Manifest(line_number));
}
let digest = parts[0];
let path = PathBuf::from(parts[2]);
if digest.len() != 64
|| !digest.bytes().all(|byte| byte.is_ascii_hexdigit())
|| !path
.components()
.all(|part| matches!(part, Component::Normal(_)))
|| !paths.insert(path.clone())
{
return Err(VerifyError::Manifest(line_number));
}
let size_bytes = parts[1]
.parse::<u64>()
.map_err(|_| VerifyError::Manifest(line_number))?;
if size_bytes == 0 {
return Err(VerifyError::Manifest(line_number));
}
records.push(ArtifactRecord {
sha256: digest.to_ascii_lowercase(),
size_bytes,
path,
family: parts[3].to_owned(),
format: parts[4].to_owned(),
applicability: parts[5].to_owned(),
});
}
if records.is_empty() {
return Err(VerifyError::Manifest(1));
}
Ok(records)
}
fn signature_matches(format: &str, first: &[u8]) -> Result<bool, VerifyError> {
let prefix: &[u8] = match format {
"IMAGEWTY-SD" | "update-zip" | "zip-installer" => b"PK\x03\x04",
"ubifs" => b"\x31\x18\x10\x06",
"swu" => b"070702",
"wm-package-0x9a5ba57c" => b"\x7c\xa5\x5b\x9a",
"bmu" => b"\x26\x01",
"bin-AES-container" => b"\x3f\x0a\x64\xae",
_ => return Err(VerifyError::UnsupportedFormat),
};
Ok(first.starts_with(prefix))
}
pub fn verify_file(path: &Path, record: &ArtifactRecord) -> Result<VerifiedArtifact, VerifyError> {
let mut file = File::open(path)?;
verify_open_file(&mut file, record)?;
Ok(VerifiedArtifact {
file,
record: record.clone(),
})
}
fn verify_open_file(file: &mut File, record: &ArtifactRecord) -> Result<(), VerifyError> {
if file.metadata()?.len() != record.size_bytes {
return Err(VerifyError::Size);
}
file.seek(SeekFrom::Start(0))?;
let mut first = [0_u8; 16];
let length = file.read(&mut first)?;
if !signature_matches(&record.format, &first[..length])? {
return Err(VerifyError::Signature);
}
file.seek(SeekFrom::Start(0))?;
let mut hasher = Sha256::new();
let mut buffer = [0_u8; 64 * 1024];
let mut read_bytes = 0_u64;
loop {
let length = file.read(&mut buffer)?;
if length == 0 {
break;
}
read_bytes += length as u64;
hasher.update(&buffer[..length]);
}
if read_bytes != record.size_bytes {
return Err(VerifyError::Size);
}
let digest = hasher.finalize();
let actual: String = digest.iter().map(|byte| format!("{byte:02x}")).collect();
if actual != record.sha256 {
return Err(VerifyError::Digest);
}
file.seek(SeekFrom::Start(0))?;
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
use std::io::Write;
#[test]
fn manifest_has_unique_safe_records() {
let records = seed_manifest().unwrap();
assert_eq!(records.len(), 14);
let traversal = format!("{HEADER}\n{},12,../escape,bin,bmu,all\n", "0".repeat(64));
assert!(matches!(
parse_manifest(&traversal),
Err(VerifyError::Manifest(2))
));
}
#[test]
fn checks_size_signature_and_digest_before_consumption() {
let path =
std::env::temp_dir().join(format!("alkane-artifact-test-{}", std::process::id()));
let bytes = b"PK\x03\x04example";
let mut file = File::create(&path).unwrap();
file.write_all(bytes).unwrap();
drop(file);
let mut record = ArtifactRecord {
sha256: Sha256::digest(bytes)
.iter()
.map(|byte| format!("{byte:02x}"))
.collect(),
size_bytes: bytes.len() as u64,
path: PathBuf::from("fixture.zip"),
family: "test".to_owned(),
format: "update-zip".to_owned(),
applicability: "test".to_owned(),
};
let mut verified = verify_file(&path, &record).unwrap();
verified.revalidate().unwrap();
let mut replay = Vec::new();
verified.reader().read_to_end(&mut replay).unwrap();
assert_eq!(replay, bytes);
std::fs::write(&path, b"PK\x03\x04changed").unwrap();
assert!(matches!(verified.revalidate(), Err(VerifyError::Digest)));
std::fs::write(&path, bytes).unwrap();
verified.revalidate().unwrap();
record.size_bytes += 1;
assert!(matches!(
verify_file(&path, &record),
Err(VerifyError::Size)
));
record.size_bytes -= 1;
record.format = "ubifs".to_owned();
assert!(matches!(
verify_file(&path, &record),
Err(VerifyError::Signature)
));
record.format = "update-zip".to_owned();
record.sha256 = "0".repeat(64);
assert!(matches!(
verify_file(&path, &record),
Err(VerifyError::Digest)
));
std::fs::remove_file(path).unwrap();
}
#[test]
#[ignore = "microbenchmark"]
fn bench_verify_artifact() {
let path =
std::env::temp_dir().join(format!("alkane-artifact-bench-{}", std::process::id()));
let mut bytes = vec![0x42_u8; 65_536];
bytes[..4].copy_from_slice(b"PK\x03\x04");
std::fs::write(&path, &bytes).unwrap();
let record = ArtifactRecord {
sha256: Sha256::digest(&bytes)
.iter()
.map(|byte| format!("{byte:02x}"))
.collect(),
size_bytes: bytes.len() as u64,
path: PathBuf::from("bench.zip"),
family: "test".to_owned(),
format: "update-zip".to_owned(),
applicability: "test".to_owned(),
};
let started = std::time::Instant::now();
for _ in 0..100 {
std::hint::black_box(verify_file(&path, &record).unwrap());
}
println!("bench_verify_artifact: {:?}", started.elapsed() / 100);
std::fs::remove_file(path).unwrap();
}
}
+1
View File
@@ -6,3 +6,4 @@ license.workspace = true
[dependencies]
alkane-core = { path = "../alkane-core" }
alkane-artifacts = { path = "../alkane-artifacts" }
+29 -2
View File
@@ -1,4 +1,31 @@
//! Headless driver over the same engine the GUI uses.
// SPDX-License-Identifier: MIT
//! Headless entry point for read-only artifact verification.
use alkane_artifacts::{seed_manifest, verify_file};
use std::path::Path;
fn run() -> Result<(), Box<dyn std::error::Error>> {
let args: Vec<_> = std::env::args().collect();
if args.len() != 4 || args[1] != "verify-artifact" {
return Err("usage: alkane-cli verify-artifact <manifest-path> <local-file>".into());
}
let record = seed_manifest()?
.into_iter()
.find(|item| item.path == Path::new(&args[2]))
.ok_or("artifact path is absent from the seed manifest")?;
let verified = verify_file(Path::new(&args[3]), &record)?;
println!(
"verified {} {} {} bytes",
verified.record().family,
verified.record().format,
verified.record().size_bytes
);
Ok(())
}
fn main() {
println!("alkane-toolkit-cli: scaffold");
if let Err(error) = run() {
eprintln!("artifact verification failed: {error}");
std::process::exit(1);
}
}
+4
View File
@@ -6,3 +6,7 @@ license.workspace = true
[dependencies]
alkane-core = { path = "../alkane-core" }
alkane-artifacts = { path = "../alkane-artifacts" }
sha2.workspace = true
thiserror.workspace = true
tempfile = "3"
+446 -1
View File
@@ -1 +1,446 @@
// alkane-flash
// SPDX-License-Identifier: MIT
//! Guarded write sequence for a verified artifact and an SDK partition plan.
//! Board transport adapters must supply serial, recovery and readback evidence.
use alkane_artifacts::VerifiedArtifact;
use sha2::{Digest, Sha256};
use std::io::{Read, Seek, SeekFrom, Write};
use thiserror::Error;
pub struct PartitionSpec {
pub name: String,
pub capacity_bytes: u64,
pub secure: bool,
pub boot_critical: bool,
}
pub struct BackupEvidence {
pub location: String,
pub bytes: u64,
pub sha256: [u8; 32],
}
pub struct WriteReceipt {
pub partition: String,
pub backup: BackupEvidence,
pub image_sha256: [u8; 32],
}
pub trait Writer {
type Error: std::fmt::Display;
fn channel_id(&self) -> &str;
fn serial_console_attached(&mut self) -> Result<bool, Self::Error>;
fn recovery_image_ready(&mut self, partition: &PartitionSpec) -> Result<bool, Self::Error>;
fn backup(&mut self, partition: &PartitionSpec) -> Result<BackupEvidence, Self::Error>;
fn write(
&mut self,
partition: &PartitionSpec,
image: &mut dyn Read,
image_size: u64,
) -> Result<(), Self::Error>;
}
pub trait IndependentReadback {
type Error: std::fmt::Display;
fn channel_id(&self) -> &str;
fn sha256(&mut self, partition: &PartitionSpec, length: u64) -> Result<[u8; 32], Self::Error>;
}
#[derive(Debug, Error, Eq, PartialEq)]
pub enum FlashError {
#[error("secure partition write refused")]
SecurePartition,
#[error("image exceeds partition capacity")]
ImageTooLarge,
#[error("boot-critical write requires an attached serial console")]
SerialRequired,
#[error("boot-critical write requires verified recovery media")]
RecoveryRequired,
#[error("readback must use an independent channel")]
SameChannel,
#[error("complete backup evidence is missing")]
BackupIncomplete,
#[error("post-write readback differs from the image")]
ReadbackMismatch,
#[error("verified image has an invalid digest")]
InvalidDigest,
#[error("image changed since verification")]
ArtifactChanged,
#[error("writer did not consume the complete image")]
IncompleteWrite,
#[error("write transport: {0}")]
Write(String),
#[error("readback transport: {0}")]
Readback(String),
#[error("artifact I/O: {0}")]
ArtifactIo(String),
}
fn digest_bytes(hex: &str) -> Result<[u8; 32], FlashError> {
if hex.len() != 64 {
return Err(FlashError::InvalidDigest);
}
let mut result = [0_u8; 32];
for (index, pair) in hex.as_bytes().chunks_exact(2).enumerate() {
let text = std::str::from_utf8(pair).map_err(|_| FlashError::InvalidDigest)?;
result[index] = u8::from_str_radix(text, 16).map_err(|_| FlashError::InvalidDigest)?;
}
Ok(result)
}
fn stage_verified_artifact(
artifact: &mut VerifiedArtifact,
size: u64,
expected: [u8; 32],
) -> Result<std::fs::File, FlashError> {
let mut staged = tempfile::tempfile().map_err(|e| FlashError::ArtifactIo(e.to_string()))?;
artifact
.reader()
.seek(SeekFrom::Start(0))
.map_err(|e| FlashError::ArtifactIo(e.to_string()))?;
let mut source = DigestReader {
inner: artifact.reader(),
remaining: size,
digest: Sha256::new(),
};
std::io::copy(&mut source, &mut staged).map_err(|e| FlashError::ArtifactIo(e.to_string()))?;
if source.remaining != 0 || <[u8; 32]>::from(source.digest.finalize()) != expected {
return Err(FlashError::ArtifactChanged);
}
staged
.flush()
.map_err(|e| FlashError::ArtifactIo(e.to_string()))?;
staged
.seek(SeekFrom::Start(0))
.map_err(|e| FlashError::ArtifactIo(e.to_string()))?;
Ok(staged)
}
struct DigestReader<'a> {
inner: &'a mut dyn Read,
remaining: u64,
digest: Sha256,
}
impl Read for DigestReader<'_> {
fn read(&mut self, buffer: &mut [u8]) -> std::io::Result<usize> {
let limit = buffer
.len()
.min(usize::try_from(self.remaining).unwrap_or(usize::MAX));
let length = self.inner.read(&mut buffer[..limit])?;
self.remaining -= length as u64;
self.digest.update(&buffer[..length]);
Ok(length)
}
}
/// Stop before reboot. The caller must still prove live boot and persistence.
pub fn write_verified<W: Writer, R: IndependentReadback>(
partition: &PartitionSpec,
artifact: &mut VerifiedArtifact,
writer: &mut W,
readback: &mut R,
) -> Result<WriteReceipt, FlashError> {
if partition.secure {
return Err(FlashError::SecurePartition);
}
let size = artifact.record().size_bytes;
if size == 0 || partition.capacity_bytes == 0 || size > partition.capacity_bytes {
return Err(FlashError::ImageTooLarge);
}
if writer.channel_id().is_empty()
|| readback.channel_id().is_empty()
|| writer.channel_id() == readback.channel_id()
{
return Err(FlashError::SameChannel);
}
if partition.boot_critical {
if !writer
.serial_console_attached()
.map_err(|e| FlashError::Write(e.to_string()))?
{
return Err(FlashError::SerialRequired);
}
if !writer
.recovery_image_ready(partition)
.map_err(|e| FlashError::Write(e.to_string()))?
{
return Err(FlashError::RecoveryRequired);
}
}
artifact
.revalidate()
.map_err(|_| FlashError::ArtifactChanged)?;
let expected = digest_bytes(&artifact.record().sha256)?;
// The source path may change while backup or transport I/O runs. Copy and
// verify it before any device write; the anonymous file is removed on drop.
let mut staged = stage_verified_artifact(artifact, size, expected)?;
let backup = writer
.backup(partition)
.map_err(|e| FlashError::Write(e.to_string()))?;
if backup.location.is_empty()
|| backup.bytes != partition.capacity_bytes
|| backup.sha256 == [0; 32]
{
return Err(FlashError::BackupIncomplete);
}
let mut stream = DigestReader {
inner: &mut staged,
remaining: size,
digest: Sha256::new(),
};
writer
.write(partition, &mut stream, size)
.map_err(|e| FlashError::Write(e.to_string()))?;
if stream.remaining != 0 {
return Err(FlashError::IncompleteWrite);
}
let written_digest: [u8; 32] = stream.digest.finalize().into();
if written_digest != expected {
return Err(FlashError::ArtifactChanged);
}
let actual = readback
.sha256(partition, size)
.map_err(|e| FlashError::Readback(e.to_string()))?;
if actual != expected {
return Err(FlashError::ReadbackMismatch);
}
Ok(WriteReceipt {
partition: partition.name.clone(),
backup,
image_sha256: expected,
})
}
#[cfg(test)]
mod tests {
use super::*;
use alkane_artifacts::{verify_file, ArtifactRecord};
use std::path::PathBuf;
const SHA: &str = "bf7d458495ed067341c7148cd3d30e6d383a2113b2cfb37de12959e057a52528";
const IMAGE: &[u8] = b"PK\x03\x04payload";
struct MockWriter {
serial: bool,
recovery: bool,
backup_bytes: u64,
max_read: Option<u64>,
writes: usize,
contents: Vec<u8>,
mutate_source_on_write: Option<PathBuf>,
}
impl Writer for MockWriter {
type Error = &'static str;
fn channel_id(&self) -> &str {
"ssh"
}
fn serial_console_attached(&mut self) -> Result<bool, Self::Error> {
Ok(self.serial)
}
fn recovery_image_ready(&mut self, _: &PartitionSpec) -> Result<bool, Self::Error> {
Ok(self.recovery)
}
fn backup(&mut self, _: &PartitionSpec) -> Result<BackupEvidence, Self::Error> {
Ok(BackupEvidence {
location: "recovery/partition.img".to_owned(),
bytes: self.backup_bytes,
sha256: [1; 32],
})
}
fn write(
&mut self,
_: &PartitionSpec,
image: &mut dyn Read,
_: u64,
) -> Result<(), Self::Error> {
self.writes += 1;
if let Some(path) = &self.mutate_source_on_write {
std::fs::write(path, b"PK\x03\x04changed").map_err(|_| "mutation failed")?;
}
if let Some(limit) = self.max_read {
image
.take(limit)
.read_to_end(&mut self.contents)
.map_err(|_| "read failed")?;
} else {
image
.read_to_end(&mut self.contents)
.map_err(|_| "read failed")?;
}
Ok(())
}
}
struct MockReadback {
channel: &'static str,
digest: [u8; 32],
}
impl IndependentReadback for MockReadback {
type Error = &'static str;
fn channel_id(&self) -> &str {
self.channel
}
fn sha256(&mut self, _: &PartitionSpec, _: u64) -> Result<[u8; 32], Self::Error> {
Ok(self.digest)
}
}
fn artifact(suffix: &str) -> (PathBuf, VerifiedArtifact) {
let path =
std::env::temp_dir().join(format!("alkane-flash-test-{}-{suffix}", std::process::id()));
std::fs::write(&path, IMAGE).unwrap();
let record = ArtifactRecord {
sha256: SHA.to_owned(),
size_bytes: IMAGE.len() as u64,
path: PathBuf::from("fixture.zip"),
family: "test".to_owned(),
format: "update-zip".to_owned(),
applicability: "test".to_owned(),
};
let verified = verify_file(&path, &record).unwrap();
(path, verified)
}
fn writer() -> MockWriter {
MockWriter {
serial: true,
recovery: true,
backup_bytes: 4096,
max_read: None,
writes: 0,
contents: Vec::new(),
mutate_source_on_write: None,
}
}
fn partition() -> PartitionSpec {
PartitionSpec {
name: "rootfs".to_owned(),
capacity_bytes: 4096,
secure: false,
boot_critical: true,
}
}
#[test]
fn refuses_secure_and_unrecoverable_writes_before_device_mutation() {
let (path, mut image) = artifact("refusals");
let mut target = partition();
let mut writer = writer();
let mut readback = MockReadback {
channel: "serial",
digest: digest_bytes(SHA).unwrap(),
};
target.secure = true;
assert!(matches!(
write_verified(&target, &mut image, &mut writer, &mut readback),
Err(FlashError::SecurePartition)
));
target.secure = false;
target.capacity_bytes = 1;
assert!(matches!(
write_verified(&target, &mut image, &mut writer, &mut readback),
Err(FlashError::ImageTooLarge)
));
target.capacity_bytes = 4096;
writer.serial = false;
assert!(matches!(
write_verified(&target, &mut image, &mut writer, &mut readback),
Err(FlashError::SerialRequired)
));
writer.serial = true;
writer.recovery = false;
assert!(matches!(
write_verified(&target, &mut image, &mut writer, &mut readback),
Err(FlashError::RecoveryRequired)
));
writer.recovery = true;
writer.backup_bytes = 1;
assert!(matches!(
write_verified(&target, &mut image, &mut writer, &mut readback),
Err(FlashError::BackupIncomplete)
));
assert_eq!(writer.writes, 0);
std::fs::remove_file(path).unwrap();
}
#[test]
fn requires_independent_matching_readback() {
let (path, mut image) = artifact("readback");
let target = partition();
let mut writer = writer();
let mut readback = MockReadback {
channel: "ssh",
digest: [0; 32],
};
assert!(matches!(
write_verified(&target, &mut image, &mut writer, &mut readback),
Err(FlashError::SameChannel)
));
assert_eq!(writer.writes, 0);
readback.channel = "serial";
assert!(matches!(
write_verified(&target, &mut image, &mut writer, &mut readback),
Err(FlashError::ReadbackMismatch)
));
assert_eq!(writer.writes, 1);
assert_eq!(writer.contents, IMAGE);
writer.contents.clear();
readback.digest = digest_bytes(SHA).unwrap();
let receipt = write_verified(&target, &mut image, &mut writer, &mut readback).unwrap();
assert_eq!(receipt.image_sha256, readback.digest);
assert_eq!(receipt.backup.bytes, 4096);
assert_eq!(writer.writes, 2);
assert_eq!(writer.contents, IMAGE);
std::fs::remove_file(path).unwrap();
}
#[test]
fn refuses_changed_or_partially_consumed_artifacts() {
let (path, mut image) = artifact("changed");
let target = partition();
let mut writer = writer();
let mut readback = MockReadback {
channel: "serial",
digest: digest_bytes(SHA).unwrap(),
};
std::fs::write(&path, b"PK\x03\x04changed").unwrap();
assert!(matches!(
write_verified(&target, &mut image, &mut writer, &mut readback),
Err(FlashError::ArtifactChanged)
));
assert_eq!(writer.writes, 0);
std::fs::write(&path, IMAGE).unwrap();
writer.max_read = Some(4);
assert!(matches!(
write_verified(&target, &mut image, &mut writer, &mut readback),
Err(FlashError::IncompleteWrite)
));
assert_eq!(writer.writes, 1);
std::fs::remove_file(path).unwrap();
}
#[test]
fn writes_verified_snapshot_when_source_changes_during_transport() {
let (path, mut image) = artifact("mutated-during-write");
let mut writer = writer();
writer.mutate_source_on_write = Some(path.clone());
let mut readback = MockReadback {
channel: "serial",
digest: digest_bytes(SHA).unwrap(),
};
let receipt = write_verified(&partition(), &mut image, &mut writer, &mut readback).unwrap();
assert_eq!(receipt.image_sha256, digest_bytes(SHA).unwrap());
assert_eq!(writer.contents, IMAGE);
assert_eq!(std::fs::read(&path).unwrap(), b"PK\x03\x04changed");
std::fs::remove_file(path).unwrap();
}
}
+3 -1
View File
@@ -305,7 +305,7 @@ async fn msgs(ip_s: &str) {
println!(" fans(rpm)={fans:?} psu_fans={}", d.psu_fans.len());
for b in d.hashboards.iter() {
println!(
" board pos={} hr={:?}TH chips={:?}/{:?} board_temp={:?} outlet_temp={:?} freq={:?}MHz volt={:?}V",
" board pos={} hr={:?}TH chips={:?}/{:?} board_temp={:?} outlet_temp={:?} freq={:?}MHz volt={:?}V chip_type={:?} hb_model={:?}",
b.position,
th(&b.hashrate),
b.working_chips,
@@ -314,6 +314,8 @@ async fn msgs(ip_s: &str) {
b.outlet_chip_temperature.as_ref().map(|t| t.as_celsius()),
b.frequency.as_ref().map(|f| f.as_megahertz()),
b.voltage.as_ref().map(|v| v.as_volts()),
b.chip_type,
b.hashboard_model,
);
}
if d.messages.is_empty() {
+125 -21
View File
@@ -550,6 +550,11 @@ pub struct MinerRow {
/// Current structured tuning target, rendered for display (e.g. "2832 W",
/// "96 TH/s", "preset 3550"), or None (round 17 C).
pub tuning_target_label: Option<String>,
/// The configured power-limit setpoint in watts, when the firmware's tuning
/// target is a power target (round 21 #2). Its own numeric Power-limit column,
/// distinct from the mixed `tuning_target_label`. None when the target is a
/// mode/preset/hashrate target or unreported.
pub power_limit_w: Option<f64>,
/// The firmware's selectable named presets/profiles, read live at scan time
/// when `caps.supports_presets` (round 18 / roadmap G3). Empty otherwise.
pub presets: Vec<MinerPreset>,
@@ -758,28 +763,41 @@ impl MinerRow {
if base.is_empty() {
return base;
}
// 2. Board-specific faults are authoritative: red the named boards. A board
// is grey ONLY when it is genuinely not detected (base Missing); a board
// that is running stays green and a faulted board is red, even when the
// PSU also reports a fault (round 18 #4b -- WhatsMiner codes 540/560 must
// show red, not grey, and boards still hashing during a PSU fault stay
// green). A whole-miner stall reds every board's base, so exonerate the
// boards the fault codes did NOT name back to healthy.
// 2. Board-specific faults layer onto the base, most-authoritative last. A
// board is grey ONLY when it is genuinely not detected (base Missing).
// An ERROR-severity fault reds a detected board (round 18 #4b --
// WhatsMiner codes 540/560 must show red; boards still hashing during a
// PSU fault stay green). A WARNING-severity fault means the board is
// still working but sub-optimal (e.g. a few dead chips while it keeps
// hashing near its target) -> yellow, never red (round 20 #1b: a miner at
// ~83% with some failed chips is degraded, not broken). A whole-miner
// stall reds every board's base, so when error codes name specific boards,
// exonerate the boards they did NOT name back to healthy.
let board_faulted = |i: usize| self.faults_for(FaultComponent::Board(i)).next().is_some();
if (0..base.len()).any(board_faulted) {
let board_warned = |i: usize| {
self.faults
.iter()
.any(|f| !f.is_error && f.component == FaultComponent::Board(i))
};
let any_error = (0..base.len()).any(board_faulted);
if any_error || (0..base.len()).any(board_warned) {
for (i, h) in base.iter_mut().enumerate() {
// A genuinely-undetected board stays grey ("not detected") even when a
// fault text names it ("chain N not found" describes that missing
// board); grey-vs-red is the documented distinction (round 18 #12).
if *h == CompHealth::Unreachable {
continue;
}
if board_faulted(i) {
// A genuinely-undetected board stays grey ("not detected") even
// when a fault text names it: a message like "chain N not found"
// describes exactly that missing board, and grey-vs-red is the
// documented distinction (round 18 #12). Only detected boards go red.
if *h != CompHealth::Unreachable {
*h = CompHealth::Down;
}
} else if *h == CompHealth::Down {
*h = ok; // stall-reddened but not named by the fault codes
*h = CompHealth::Down; // red: an error fault on a detected board
} else if any_error && *h == CompHealth::Down {
*h = ok; // stall-reddened but not named by the error codes
}
// A warning (no error) degrades a still-running board to yellow, but
// never upgrades a board already red.
if !board_faulted(i) && board_warned(i) && *h != CompHealth::Down {
*h = CompHealth::Degraded;
}
// else keep the base (green Ok / grey Missing).
}
}
base
@@ -1182,6 +1200,9 @@ pub enum Column {
// Round 19 #10: more scanned values surfaced as columns.
/// Current tuning target (power or hashrate), e.g. "3200 W" or "100 TH".
Target,
/// Configured power-limit setpoint in watts (round 21 #2), e.g. WhatsMiner
/// "Power Limit". A dedicated numeric column, distinct from the mixed Target.
PowerLimit,
/// Accepted / rejected share counts and the rejection ratio.
Accepted,
Rejected,
@@ -1209,7 +1230,7 @@ pub enum Column {
/// Every column, in registry order. Ip first, then the default-visible set
/// (UI-SPEC order), then all remaining metrics.
pub const ALL_COLUMNS: [Column; 72] = [
pub const ALL_COLUMNS: [Column; 73] = [
Column::Ip,
Column::Hashrate,
Column::Hashrate1m,
@@ -1267,6 +1288,7 @@ pub const ALL_COLUMNS: [Column; 72] = [
Column::SessionBestShare,
Column::TuningPercent,
Column::Target,
Column::PowerLimit,
Column::Accepted,
Column::Rejected,
Column::RejectRatio,
@@ -1321,6 +1343,7 @@ impl Column {
Column::Fan4 => "Fan 4 (RPM)",
Column::FanSpeedPercent => "Fan %",
Column::Target => "Target",
Column::PowerLimit => "Power limit",
Column::Accepted => "Accepted",
Column::Rejected => "Rejected",
Column::RejectRatio => "Reject %",
@@ -1401,6 +1424,7 @@ impl Column {
Column::Fan1 | Column::Fan2 | Column::Fan3 | Column::Fan4 | Column::PsuFan => 90,
Column::FanSpeedPercent => 80,
Column::Target => 110,
Column::PowerLimit => 95,
Column::Accepted | Column::Rejected => 100,
Column::RejectRatio => 90,
Column::DiffAccepted | Column::DiffRejected => 110,
@@ -1489,6 +1513,7 @@ impl Column {
| Column::BestShare
| Column::SessionBestShare
| Column::TuningPercent
| Column::PowerLimit
)
}
@@ -1575,6 +1600,7 @@ impl Column {
Column::BoardVoltage => SortKey::Num(avg_positive(&r.board_voltages, none)),
Column::BoardFrequency => SortKey::Num(avg_positive(&r.board_frequencies, none)),
Column::PsuFan => SortKey::Num(r.psu_fan_rpm),
Column::PowerLimit => SortKey::Num(r.power_limit_w.unwrap_or(none)),
Column::PsuVMin => SortKey::Num(r.psu_voltage_min_v.unwrap_or(none)),
Column::PsuVMax => SortKey::Num(r.psu_voltage_max_v.unwrap_or(none)),
Column::FanCount => SortKey::Num(r.fan_count.map(|v| v as f64).unwrap_or(none)),
@@ -1670,6 +1696,7 @@ impl Column {
r.fan_speed_percent.map(|v| format!("{v:.0}%")).unwrap_or_default()
}
Column::Target => r.tuning_target_label.clone().unwrap_or_default(),
Column::PowerLimit => r.power_limit_w.map(|w| format!("{w:.0} W")).unwrap_or_default(),
Column::Accepted => r.accepted_shares.map(|v| v.to_string()).unwrap_or_default(),
Column::Rejected => r.rejected_shares.map(|v| v.to_string()).unwrap_or_default(),
Column::RejectRatio => r.reject_ratio().map(|v| format!("{v:.2}%")).unwrap_or_default(),
@@ -1779,8 +1806,8 @@ impl Column {
Column::Hashrate | Column::HashrateRel | Column::Hashrate1m | Column::Hashrate5m
| Column::Hashrate15m | Column::Hashrate24h | Column::Power | Column::Efficiency
| Column::TuningPercent | Column::BestShare | Column::SessionBestShare
| Column::Uptime | Column::Target | Column::BoardHashrate | Column::BoardVoltage
| Column::BoardFrequency => (3, "Performance"),
| Column::Uptime | Column::Target | Column::PowerLimit | Column::BoardHashrate
| Column::BoardVoltage | Column::BoardFrequency => (3, "Performance"),
Column::ChipTemp | Column::FluidTemp | Column::EnvTemp | Column::OutletTemp
| Column::TargetTemp | Column::HotTemp | Column::DangerousTemp => {
(4, "Temperature")
@@ -2237,6 +2264,51 @@ mod tests {
assert_eq!(mb[2], CompHealth::Unreachable, "undetected board named by a fault stays grey");
}
#[test]
fn warning_fault_degrades_board_to_yellow_not_red() {
// Round 21 #1: a board still mining near full hashrate with some failed/
// degraded chips reports a WARNING-severity fault. It must render yellow
// (Degraded), not red (Down) -- red is reserved for an error (down board).
let warn = |c: FaultComponent, m: &str| Fault {
component: c,
message: m.to_string(),
code: 0,
is_error: false,
};
let err = |c: FaultComponent, m: &str| Fault {
component: c,
message: m.to_string(),
code: 0,
is_error: true,
};
// Three mining boards; board 0 has a warning (dead chips), board 2 an error.
let r = MinerRow {
is_mining: true,
board_status: vec![BoardHealth::Ok, BoardHealth::Ok, BoardHealth::Ok],
faults: vec![
warn(FaultComponent::Board(0), "Hashboard 1: 10 failed chip(s)"),
err(FaultComponent::Board(2), "Hashboard 3: stopped"),
],
..Default::default()
};
let b = r.board_healths();
assert_eq!(b[0], CompHealth::Degraded, "warning -> yellow");
assert_eq!(b[1], CompHealth::Ok, "no fault -> green");
assert_eq!(b[2], CompHealth::Down, "error -> red");
// A warning never upgrades a board already red from an error on the same board.
let both = MinerRow {
is_mining: true,
board_status: vec![BoardHealth::Ok],
faults: vec![
warn(FaultComponent::Board(0), "degraded chips"),
err(FaultComponent::Board(0), "stopped"),
],
..Default::default()
};
assert_eq!(both.board_healths()[0], CompHealth::Down, "error wins over warning");
}
#[test]
fn equihash_hashrate_units_round18() {
// SHA256 shows the TH/s value directly; Equihash shows the Sol/s count
@@ -2532,6 +2604,38 @@ mod tests {
assert!(per.as_millis() < 100, "cell rendering regressed: {per:?}");
}
/// Microbenchmark: component health scores and operator-facing diagnostics
/// recomputed when scan results refresh the table.
#[test]
#[ignore]
fn bench_health_diagnostics() {
use std::hint::black_box;
use std::time::Instant;
let rows = bench_fleet();
let iters = 1000u32;
let start = Instant::now();
let mut sink = 0usize;
for _ in 0..iters {
for row in &rows {
for facet in [
HealthFacet::Overall,
HealthFacet::Power,
HealthFacet::Fans,
HealthFacet::Boards,
] {
sink += black_box(row.health_score(facet)) as usize;
}
sink += row.health_summary().len();
sink += row.health_tooltips(4, 3).iter().map(String::len).sum::<usize>();
}
}
black_box(sink);
let per = start.elapsed() / iters;
println!("bench_health_diagnostics: {} rows = {:?}/refresh", rows.len(), per);
assert!(per.as_millis() < 20, "health diagnostics regressed: {per:?}/refresh");
}
#[test]
fn selection_survives_upsert() {
let mut rows = bench_fleet();
+89 -1
View File
@@ -58,7 +58,11 @@ pub fn firmware_family(raw: &str) -> (String, Option<String>) {
// Vendor prefixes asic-rs prepends on stock-firmware family strings, matched
// case-insensitively.
for vendor in ["AntMiner", "WhatsMiner"] {
if trimmed.len() > vendor.len() && trimmed[..vendor.len()].eq_ignore_ascii_case(vendor) {
if trimmed.len() > vendor.len()
&& trimmed
.get(..vendor.len())
.is_some_and(|prefix| prefix.eq_ignore_ascii_case(vendor))
{
let rest = trimmed[vendor.len()..].trim();
if !rest.is_empty() {
return (rest.to_string(), Some(vendor.to_string()));
@@ -95,6 +99,44 @@ pub fn clean_model(make: &str, model_id: &str) -> String {
}
}
/// Best-effort ASIC chip model for a miner, used ONLY as a fallback when the
/// firmware did not report a chip type on the wire (round 21 #3). Most firmwares
/// on Antminer hardware (stock Antminer, VNish, LuxOS, Braiins, UMC) never put the
/// chip string in their API, but the chip is a fixed per-model hardware fact, so
/// it can be derived from the detected model. Only high-confidence, widely
/// documented Antminer mappings are returned; everything else (and WhatsMiner,
/// whose chips are not cleanly named) returns None so the column stays blank
/// rather than show a guess. `model_id` is the raw asic-rs model id.
pub fn chip_type_for_model(make: &str, model_id: &str) -> Option<&'static str> {
if !is_antminer(make) {
return None;
}
// Normalize: drop a leading "ANTMINER ", cut any trailing parenthetical
// ("S19 (88)" -> "S19"), uppercase, and strip every non-alphanumeric char.
let base = model_id.trim();
let base = base
.strip_prefix("ANTMINER ")
.or_else(|| base.strip_prefix("Antminer "))
.unwrap_or(base);
let base = base.split('(').next().unwrap_or(base);
let key: String = base
.chars()
.filter(|c| c.is_ascii_alphanumeric())
.map(|c| c.to_ascii_uppercase())
.collect();
// Bitmain chip per model (SHA-256 air/hydro). Sources: Bitmain shop specs +
// repair-guide chip markings. Keep conservative -- omit uncertain variants.
let chip = match key.as_str() {
"S19" | "S19PRO" | "S19A" | "S19APRO" | "T19" => "BM1398",
"S19PROPLUSHYD" | "S19PROPLUSHYDRO" | "S19PROHYD" | "S19PROHYDRO" => "BM1398",
"S19J" | "S19JPRO" | "S19JPROPLUS" | "S19JPRONOPIC" => "BM1362",
"S19XP" | "S19XPHYD" | "S19XPHYDRO" | "S19KPRO" | "S19KPRONOPIC" => "BM1366",
"S21" | "S21PRO" | "S21PLUS" | "S21HYD" | "S21HYDRO" | "T21" => "BM1370",
_ => return None,
};
Some(chip)
}
/// The Submodel column value. WhatsMiner: the version block ("VE40"). Antminer:
/// empty -- the hashboard type is not reported over the network by asic-rs.
pub fn submodel(make: &str, model_id: &str) -> String {
@@ -313,6 +355,23 @@ pub fn equihash_expected_sols(clean_model: &str) -> Option<f64> {
mod tests {
use super::*;
#[test]
fn chip_type_derivation() {
// Fleet models (round 21 #3): derived from the detected model for Antminer
// hardware where the firmware does not report a chip string on the wire.
assert_eq!(chip_type_for_model("Antminer", "S21Pro"), Some("BM1370"));
assert_eq!(chip_type_for_model("Antminer", "S19jPro"), Some("BM1362"));
assert_eq!(chip_type_for_model("Antminer", "S19KPro"), Some("BM1366"));
assert_eq!(chip_type_for_model("Antminer", "S19"), Some("BM1398"));
assert_eq!(chip_type_for_model("Antminer", "T19"), Some("BM1398"));
// Raw "Unknown" passthrough with brand + parenthetical normalizes to S19.
assert_eq!(chip_type_for_model("Antminer", "ANTMINER S19 (88)"), Some("BM1398"));
// WhatsMiner chips are not cleanly named -> never derived.
assert_eq!(chip_type_for_model("Whatsminer", "M30S+VE40"), None);
// Unknown Antminer model -> None (no guess).
assert_eq!(chip_type_for_model("Antminer", "L7"), None);
}
#[test]
fn brand_normalises_case() {
assert_eq!(brand("Antminer"), "Antminer");
@@ -422,6 +481,35 @@ mod tests {
assert_eq!(firmware_family("Braiins"), ("Braiins".to_string(), None));
// A bare vendor word with nothing after it is left as-is (not emptied).
assert_eq!(firmware_family("AntMiner"), ("AntMiner".to_string(), None));
// Firmware strings arrive from the network and may contain UTF-8 at
// the byte position used to check a vendor prefix.
let non_ascii = "AntMine\u{e9} Stock";
assert_eq!(firmware_family(non_ascii), (non_ascii.to_string(), None));
}
#[test]
#[ignore = "microbenchmark"]
fn bench_naming_transforms() {
let cases = [
("Antminer", "S19jPro", "AntMiner Stock", "Xilinx"),
("Antminer", "S21Pro", "VNish", "CVITek"),
("Whatsminer", "M30SPlusVE40", "WhatsMiner Stock", "H616"),
("Whatsminer", "M50SPlusPlusVK30", "Braiins", "H6"),
];
let iterations = 20_000;
let started = std::time::Instant::now();
for index in 0..iterations {
let (make, model, firmware, board) = cases[index % cases.len()];
let clean = clean_model(make, model);
std::hint::black_box(firmware_family(firmware));
std::hint::black_box(control_board_code(make, board, &clean));
std::hint::black_box(chip_type_for_model(make, model));
std::hint::black_box(clean);
}
let elapsed = started.elapsed();
let per = elapsed / iterations as u32;
println!("bench_naming_transforms: {per:?}/record");
assert!(elapsed < std::time::Duration::from_millis(500));
}
#[test]
+14 -2
View File
@@ -993,6 +993,10 @@ async fn to_row(miner: &dyn Miner) -> MinerRow {
TuningTarget::Preset(s) => format!("preset {s}"),
TuningTarget::Manual { .. } => "manual".to_string(),
});
// The configured power-limit setpoint in watts, when the target is a power
// target (WhatsMiner "Power Limit", VNish/Braiins power targets). Its own
// numeric column (round 21 #2), distinct from the mixed Target label.
let power_limit_w = data.tuning_target.as_ref().and_then(&target_watts);
// A hashrate target is offerable only where the firmware actively tunes by
// hashrate through set_tuning_config (ePIC); Braiins advertises a hashrate
// envelope but has no set_tuning_config wired, so it is excluded.
@@ -1074,8 +1078,15 @@ async fn to_row(miner: &dyn Miner) -> MinerRow {
algorithm,
// ASIC chip type + hashboard model, from the first board that reports them
// (uniform across boards); empty where the firmware doesn't expose them
// (round 19 #10).
chip_type: data.hashboards.iter().find_map(|b| b.chip_type.clone()).unwrap_or_default(),
// (round 19 #10). When no board reports a chip type (VNish/stock
// Antminer/LuxOS never do), fall back to the fixed per-model chip for
// Antminer hardware (round 21 #3).
chip_type: data
.hashboards
.iter()
.find_map(|b| b.chip_type.clone())
.or_else(|| crate::naming::chip_type_for_model(&make, &model_id).map(str::to_string))
.unwrap_or_default(),
hashboard_model: data
.hashboards
.iter()
@@ -1145,6 +1156,7 @@ async fn to_row(miner: &dyn Miner) -> MinerRow {
psu_voltage_min_v: data.psu.as_ref().and_then(|p| p.voltage_min),
psu_voltage_max_v: data.psu.as_ref().and_then(|p| p.voltage_max),
tuning_target_label,
power_limit_w,
power_target_min_w,
power_target_max_w,
hashrate_target_min_ths,
+6 -6
View File
@@ -1,10 +1,10 @@
# UI Spec — primary view
# Primary view
Source: operator description, 2026-09-15. Status: ACCEPTED (v1 scope).
## Header (above the table)
## Header
- **KPI block, top left — 6 KPIs:**
- **KPI block, top left: 6 KPIs:**
1. Total miners
2. Hashing
3. Slow
@@ -31,7 +31,7 @@ Source: operator description, 2026-09-15. Status: ACCEPTED (v1 scope).
4. Cooling (fan)
5. Firmware
6. Pool worker account name
7. …then the remaining statistics in registry order.
7. Remaining statistics in registry order.
## Data sources
@@ -45,10 +45,10 @@ Source: operator description, 2026-09-15. Status: ACCEPTED (v1 scope).
ships with the board registry; missing band = excluded from Slow, counted
in Hashing).
## Implementation notes
## Implementation
- wxWidgets: the view is a `wxDataViewListCtrl`/`wxDataViewCtrl` (virtual
list — thousands of rows without materializing cells), checkbox column +
list for thousands of rows without materializing cells), checkbox column +
IP column fixed via attribute/serializer, drag reorder via `wxReorderable`
column events, sort via column header click events mapped to the model.
- Filter panel: per-column distinct-value checklist with text search,
+1 -1
View File
@@ -1,4 +1,4 @@
# ADR 0001: Recipes as data, interpreted by one engine
# ADR 0001: Recipe engine
Status: ACCEPTED
Date: 2026-09-14
+15 -29
View File
@@ -1,41 +1,27 @@
# ADR 0002: GUI bindings — wxWidgets shell in C++ + Rust core, spike to revisit
# ADR 0002: GUI bindings
Status: RESOLVED 2026-09-15 - the operator chose Option B (pure Rust via
wx-rs) with vendoring (ADR-0003). wx-rs 0.2.0 was extended via the patch
queue: Linux/GTK3 wx-config build path plus the widget bridge (panel,
sizers, static text, button, text ctrl, checkbox, checklistbox, dialog,
data view list ctrl, timer). The app ships this way; no C++ shell.
Date: 2026-09-14
Resolved: 2026-09-15
## Context
The toolkit must present a native cross-platform GUI (wxWidgets chosen).
Rust bindings to wxWidgets checked on crates.io 2026-09-14:
- `wxRust` 0.0.1-alpha — unmaintained since 2022.
- `wx-rs` 0.2.0 (2023, self-contained) — ~6k downloads, no 1.0.
Betting the GUI on alpha bindings risks weeks of binding-gap debugging
(paste-heavy widgets, worker threads + event loops, GTK/WinCocoa quirks).
The toolkit needs a native wxWidgets GUI. At the time of evaluation,
`wxRust` 0.0.1-alpha had seen no maintenance since 2022, and `wx-rs`
0.2.0 lacked widgets needed for the Toolkit.
## Decision
Default: **thin C++17 wxWidgets shell (`gui/`) + Rust core exposed over a
small stable C ABI** (cdylib from `alkane-core`, header generated with
cbindgen). The shell holds frames, lists, the install wizard, and event
glue only — no business logic, no safety logic. All invariants, engines,
and tests live in Rust where they are testable headlessly.
The operator chose a Rust GUI through a vendored, patched `wx-rs` 0.2.0.
The patch queue adds the Linux/GTK3 build path and bindings for panels,
sizers, controls, dialogs, data views, timers, and event dispatch. The
application uses this bridge; it has no separate C++ shell.
Gate: M0 runs a time-boxed `wx-rs` spike (window + list/tree + wizard flow
+ worker-thread progress + cancel on Linux and Windows). If the spike is
solid, flip to pure Rust; either way the decision is recorded before M3.
The original proposal was a small C++17 wxWidgets shell calling a Rust
core through a C ABI. The `wx-rs` spike met the GUI need, so that proposal
was not adopted.
## Consequences
- The repo builds two things: a Rust workspace and a small C++ app linked
against the core cdylib. CMake in `gui/`.
- Core API surface stays small and event-oriented (discover, identify,
plan, execute, cancel, progress events, log tail) — good FFI hygiene and
a natural match for the CLI too (D4).
- If wx-rs wins the spike, the C ABI is kept as an integration boundary for
scripted/HIL use anyway.
- Keep business logic and safety checks in testable Rust code.
- Carry wx-rs changes as numbered patches under `thirdparty/wx-rs/patches`.
- Recheck the bridge on Linux, Windows, and macOS packaging changes.
+2 -2
View File
@@ -1,4 +1,4 @@
# ADR 0003: Vendoring policy — pristine upstream archives + patch queue
# ADR 0003: Vendoring
Status: ACCEPTED
Date: 2026-09-15
@@ -42,7 +42,7 @@ thirdparty/
Rules:
1. Never edit a vendored pristine tree in place — every local change is a
1. Never edit a vendored pristine tree in place. Every local change is a
patch in `patches/`, applied by the build in numeric order. This makes
an upstream update: replace pristine archive, `git apply` surviving
patches, rebase the rest.
+1
View File
@@ -5,6 +5,7 @@
# scripts/build-wx-linux.sh to produce it).
set -e
REPO=$(CDPATH= cd -- "$(dirname -- "$0")/.." && pwd)
trap 'bash "$REPO/scripts/clean-old-builds.sh" || true' 0
WX_PREFIX="${1:-$HOME/.cache/wx-3.3.3-linux}"
if [ ! -x "$WX_PREFIX/bin/wx-config" ]; then
"$REPO/scripts/build-wx-linux.sh"
+15
View File
@@ -6,6 +6,21 @@ REPO=$(CDPATH= cd -- "$(dirname -- "$0")/.." && pwd)
SRC="$REPO/thirdparty/wxwidgets/wxWidgets-3.3.3"
BUILD="$HOME/.cache/wxbuild/wxWidgets-3.3.3"
PREFIX="$HOME/.cache/wx-3.3.3-linux"
cleanup_wx_build() {
python3 - "$BUILD" "$HOME/.cache/wxbuild" <<'PY'
from pathlib import Path
import shutil
import sys
build, parent = map(Path, sys.argv[1:])
if (build.name != "wxWidgets-3.3.3" or build.parent != parent
or build.is_symlink() or parent.is_symlink()):
raise SystemExit("refusing unsafe wxWidgets build cleanup path")
if build.is_dir():
shutil.rmtree(build)
PY
}
trap cleanup_wx_build 0
[ -d "$BUILD" ] || { mkdir -p "$HOME/.cache/wxbuild"; cp -r "$SRC" "$BUILD"; }
[ -d "$BUILD" ] || { echo "thirdparty wxWidgets tree missing"; exit 1; }
chmod +x "$BUILD/configure" "$BUILD/config.guess" "$BUILD/config.sub" "$BUILD/install-sh" 2>/dev/null || true
+9
View File
@@ -18,6 +18,15 @@
set -uo pipefail
TARGET="${CARGO_TARGET_DIR:-$HOME/.cache/alkane-tk-target}"
REPO="$(cd "$(dirname "$0")/.." && pwd)"
case "$(realpath -m "$TARGET")" in
"$HOME/.cache/alkane-tk-target"|"$REPO/target") ;;
*) echo "clean-old-builds: refusing unexpected target $TARGET" >&2; exit 1 ;;
esac
if [ -L "$TARGET" ]; then
echo "clean-old-builds: refusing symlink target $TARGET" >&2
exit 1
fi
if [ ! -d "$TARGET" ]; then
echo "clean-old-builds: no target dir at $TARGET (nothing to do)"
exit 0
+27 -17
View File
@@ -8,13 +8,13 @@
#
# Usage: scripts/ui-screenshot.sh [out.png] [--live] [binary]
set -u
REPO=$(CDPATH= cd -- "$(dirname -- "$0")/.." && pwd)
REPO=$(CDPATH='' cd -- "$(dirname -- "$0")/.." && pwd)
WX_PREFIX="${WX_PREFIX:-$HOME/.cache/wx-3.3.3-linux}"
export WX_RS_WXCONFIG="${WX_RS_WXCONFIG:-$WX_PREFIX/bin/wx-config}"
OUT="${1:-alkane-toolkit.png}"
LIVE=0; BIN=""
shift 2>/dev/null || true
[ "$#" -eq 0 ] || shift
for a in "$@"; do
case "$a" in
--live) LIVE=1 ;;
@@ -32,17 +32,31 @@ if [ -z "$BIN" ]; then
fi
[ -x "$BIN" ] || { echo "binary not found: $BIN" >&2; exit 3; }
DISP=":98"
FAKE_ENV="ALKANE_FAKE_SCAN=1"
[ "$LIVE" = "1" ] && FAKE_ENV=""
Xvfb "$DISP" -screen 0 1280x850x24 -nolisten tcp >/dev/null 2>&1 &
DISPLAY_FILE=$(mktemp)
XPID=""; APID=""; WARM=""
cleanup() {
[ -z "$APID" ] || kill "$APID" 2>/dev/null || true
[ -z "$WARM" ] || kill "$WARM" 2>/dev/null || true
[ -z "$XPID" ] || kill "$XPID" 2>/dev/null || true
rm -f "$DISPLAY_FILE"
}
trap cleanup EXIT
Xvfb -displayfd 3 -screen 0 1280x850x24 -nolisten tcp 3>"$DISPLAY_FILE" >/dev/null 2>&1 &
XPID=$!
sleep 1.2
for _ in {1..30}; do
[ -s "$DISPLAY_FILE" ] && break
kill -0 "$XPID" 2>/dev/null || { echo "Xvfb exited before startup" >&2; exit 3; }
sleep 0.1
done
[ -s "$DISPLAY_FILE" ] || { echo "Xvfb did not start" >&2; exit 3; }
DISP=":$(cat "$DISPLAY_FILE")"
# warm the font/GTK caches so the first window map is not stalled
DISPLAY="$DISP" xclock >/dev/null 2>&1 & WARM=$!; sleep 1.2; kill "$WARM" 2>/dev/null
# shellcheck disable=SC2086
DISPLAY="$DISP" GDK_BACKEND=x11 $FAKE_ENV "$BIN" >/dev/null 2>&1 &
if [ "$LIVE" = "1" ]; then
DISPLAY="$DISP" GDK_BACKEND=x11 "$BIN" >/dev/null 2>&1 &
else
DISPLAY="$DISP" GDK_BACKEND=x11 ALKANE_FAKE_SCAN=1 "$BIN" >/dev/null 2>&1 &
fi
APID=$!
WID=""; t=0
while [ "$t" -lt 25 ]; do
@@ -52,10 +66,6 @@ while [ "$t" -lt 25 ]; do
[ -n "$line" ] && { WID=$(echo "$line" | awk '{print $1}'); break; }
done
sleep 2 # let it paint and drain a scan tick
if [ -n "$WID" ]; then
DISPLAY="$DISP" import -window "$WID" "$OUT" && echo "wrote $OUT (window $WID, ${t}s)"
else
DISPLAY="$DISP" import -window root "$OUT"; echo "no app window; captured root -> $OUT" >&2
fi
kill "$APID" 2>/dev/null
kill "$XPID" 2>/dev/null
[ -n "$WID" ] || { echo "no app window mapped" >&2; exit 1; }
DISPLAY="$DISP" import -window "$WID" "$OUT" || exit 1
echo "wrote $OUT (window $WID, ${t}s)"
@@ -0,0 +1,243 @@
Subject: [PATCH 0033] vnish hashboard model + chip-fail severity; whatsminer PSU serial
Round 21 #1 + #3.
- VNish per-board chip failures while the board is still MINING are now Warning
(yellow), not Error (red): dead/degraded chips on a board that keeps hashing
near its target are wear, not a down board. A board NOT in a normal mining
state stays Error (red). Both v1_2_0 and v1_3_0. (The GUI renders a warning-only
board as Degraded/yellow.)
- VNish hashboard model: parse_hashboards now reads the factory-info
/chains[]/board_model (e.g. "A3HB70601" on S21 Pro, "BHB42603" on S19j Pro),
keyed by chain id, into BoardData.hashboard_model. The factory-info endpoint is
already fetched for the PSU serial; neither the live /chains nor /summary carry
board_model. Both backends. Verified live (10.4.0.193, 10.4.1.218).
- WhatsMiner v1/v2 PSU serial: get_psu /Msg exposes serial_no (e.g.
"1355A2129604289"); parse_psu now reads it (it was hardcoded None with an
incorrect "v1/v2 does not report a serial" comment). Verified live (10.8.1.145).
diff --git a/vendor/asic-rs-firmwares-vnish/src/backends/v1_2_0/mod.rs b/vendor/asic-rs-firmwares-vnish/src/backends/v1_2_0/mod.rs
index 85011853..2c14f217 100644
--- a/vendor/asic-rs-firmwares-vnish/src/backends/v1_2_0/mod.rs
+++ b/vendor/asic-rs-firmwares-vnish/src/backends/v1_2_0/mod.rs
@@ -296,6 +296,16 @@ impl GetDataLocations for VnishV120 {
tag: Some("unit"),
},
),
+ // Per-board hashboard model ("board_model") from factory-info, which
+ // the live /chains + /summary do not carry. Already fetched for serial.
+ (
+ WEB_FACTORY_INFO,
+ DataExtractor {
+ func: get_by_pointer,
+ key: Some("/chains"),
+ tag: Some("factory"),
+ },
+ ),
],
DataField::Chips => vec![(
WEB_CHAINS,
@@ -493,6 +503,11 @@ impl GetHashboards for VnishV120 {
.unwrap_or(HashRateUnit::GigaHash);
let algo = self.device_info.algo;
let chip_chains = data.get(&DataField::Chips).and_then(|v| v.as_array());
+ // Factory-info chains carry the hashboard model (board_model), keyed by the
+ // same 1-based chain id. Not present on the live /chains or /summary.
+ let factory_chains = hashboards_data
+ .and_then(|v| v.pointer("/factory"))
+ .and_then(|v| v.as_array());
let mut hashboards: Vec<BoardData> =
(0..self.device_info.hardware.board_count().unwrap_or(0) as usize)
@@ -642,6 +657,16 @@ impl GetHashboards for VnishV120 {
.and_then(|v| v.as_str())
.map(|s| s == "mining")
.or_else(|| board.hashrate.as_ref().map(|h| h.value > 0.0));
+ // Hashboard model from factory-info (board_model), matched by chain id.
+ board.hashboard_model = factory_chains.and_then(|chains| {
+ chains
+ .iter()
+ .find(|c| c.pointer("/id").and_then(|v| v.as_u64()) == Some(id))
+ .and_then(|c| c.pointer("/board_model"))
+ .and_then(|v| v.as_str())
+ .filter(|s| !s.is_empty())
+ .map(String::from)
+ });
}
hashboards
@@ -919,22 +944,31 @@ impl GetMessages for VnishV120 {
"" | "mining" | "auto-tuning" | "auto_tuning" | "tuning"
);
- if red > 0 {
+ // Severity reflects whether the board is still doing its job. A board
+ // NOT in a normal mining state is down -> Error (red). A board that is
+ // still mining but has some failed/degraded chips is sub-optimal, not
+ // broken -> Warning (yellow): dead chips while the board keeps hashing
+ // near its target are wear, not a fault (a ~83%-hashrate board must not
+ // read as broken).
+ if !state_ok {
+ let detail = if red > 0 {
+ format!("Hashboard {id}: {state} ({red} failed chip(s))")
+ } else {
+ format!("Hashboard {id}: {state}")
+ };
messages.push(MinerMessage::with_component(
0,
0,
- format!("Hashboard {id}: {red} failed chip(s)"),
+ detail,
MessageSeverity::Error,
Some(MinerComponent::hashboard(idx)),
));
- } else if !state_ok {
- // A board not in a normal state but with no failed chips: report
- // the state itself (e.g. "initializing", "disabled", "stopped").
+ } else if red > 0 {
messages.push(MinerMessage::with_component(
0,
0,
- format!("Hashboard {id}: {state}"),
- MessageSeverity::Error,
+ format!("Hashboard {id}: {red} failed chip(s)"),
+ MessageSeverity::Warning,
Some(MinerComponent::hashboard(idx)),
));
} else if orange > 0 {
diff --git a/vendor/asic-rs-firmwares-vnish/src/backends/v1_3_0/mod.rs b/vendor/asic-rs-firmwares-vnish/src/backends/v1_3_0/mod.rs
index 1301a657..e6247923 100644
--- a/vendor/asic-rs-firmwares-vnish/src/backends/v1_3_0/mod.rs
+++ b/vendor/asic-rs-firmwares-vnish/src/backends/v1_3_0/mod.rs
@@ -294,6 +294,17 @@ impl GetDataLocations for VnishV130 {
tag: Some("unit"),
},
),
+ // Per-board hashboard model ("board_model", e.g. "A3HB70601") from
+ // the factory-info endpoint, which the live /chains + /summary do not
+ // carry. Already fetched for the PSU serial.
+ (
+ WEB_FACTORY_INFO,
+ DataExtractor {
+ func: get_by_pointer,
+ key: Some("/chains"),
+ tag: Some("factory"),
+ },
+ ),
],
DataField::Chips => vec![(
WEB_CHAINS,
@@ -499,6 +510,11 @@ impl GetHashboards for VnishV130 {
.unwrap_or(HashRateUnit::GigaHash);
let algo = self.device_info.algo;
let chip_chains = data.get(&DataField::Chips).and_then(|v| v.as_array());
+ // Factory-info chains carry the hashboard model (board_model), keyed by the
+ // same 1-based chain id. Not present on the live /chains or /summary.
+ let factory_chains = hashboards_data
+ .and_then(|v| v.pointer("/factory"))
+ .and_then(|v| v.as_array());
let mut hashboards: Vec<BoardData> =
(0..self.device_info.hardware.board_count().unwrap_or(0) as usize)
@@ -648,6 +664,16 @@ impl GetHashboards for VnishV130 {
.and_then(|v| v.as_str())
.map(|s| s == "mining")
.or_else(|| board.hashrate.as_ref().map(|h| h.value > 0.0));
+ // Hashboard model from factory-info (board_model), matched by chain id.
+ board.hashboard_model = factory_chains.and_then(|chains| {
+ chains
+ .iter()
+ .find(|c| c.pointer("/id").and_then(|v| v.as_u64()) == Some(id))
+ .and_then(|c| c.pointer("/board_model"))
+ .and_then(|v| v.as_str())
+ .filter(|s| !s.is_empty())
+ .map(String::from)
+ });
}
hashboards
@@ -874,22 +900,31 @@ impl GetMessages for VnishV130 {
"" | "mining" | "auto-tuning" | "auto_tuning" | "tuning"
);
- if red > 0 {
+ // Severity reflects whether the board is still doing its job. A board
+ // NOT in a normal mining state is down -> Error (red). A board that is
+ // still mining but has some failed/degraded chips is sub-optimal, not
+ // broken -> Warning (yellow): dead chips while the board keeps hashing
+ // near its target are wear, not a fault (a ~83%-hashrate board must not
+ // read as broken).
+ if !state_ok {
+ let detail = if red > 0 {
+ format!("Hashboard {id}: {state} ({red} failed chip(s))")
+ } else {
+ format!("Hashboard {id}: {state}")
+ };
messages.push(MinerMessage::with_component(
0,
0,
- format!("Hashboard {id}: {red} failed chip(s)"),
+ detail,
MessageSeverity::Error,
Some(MinerComponent::hashboard(idx)),
));
- } else if !state_ok {
- // A board not in a normal state but with no failed chips: report
- // the state itself (e.g. "initializing", "disabled", "stopped").
+ } else if red > 0 {
messages.push(MinerMessage::with_component(
0,
0,
- format!("Hashboard {id}: {state}"),
- MessageSeverity::Error,
+ format!("Hashboard {id}: {red} failed chip(s)"),
+ MessageSeverity::Warning,
Some(MinerComponent::hashboard(idx)),
));
} else if orange > 0 {
diff --git a/vendor/asic-rs-firmwares-whatsminer/src/backends/v1/mod.rs b/vendor/asic-rs-firmwares-whatsminer/src/backends/v1/mod.rs
index 4025a931..8d5dad3c 100644
--- a/vendor/asic-rs-firmwares-whatsminer/src/backends/v1/mod.rs
+++ b/vendor/asic-rs-firmwares-whatsminer/src/backends/v1/mod.rs
@@ -557,14 +557,15 @@ impl GetWattage for WhatsMinerV1 {
}
fn parse_psu(&self, data: &HashMap<DataField, Value>) -> Option<PsuInfo> {
- // get_psu /Msg -> {model, hw_version, sw_version, ...} (values are strings).
- // No DC output voltage or rated envelope is exposed, so only identity is set.
+ // get_psu /Msg -> {model, name, hw_version, sw_version, serial_no, ...}
+ // (values are strings). No DC output voltage or rated envelope is exposed, so
+ // only identity (model/version/serial) is set.
let d = data.get(&DataField::Psu)?;
let s = |k: &str| d.pointer(k).and_then(|v| v.as_str()).filter(|s| !s.is_empty()).map(str::to_string);
let psu = PsuInfo {
model: s("/model").or_else(|| s("/name")),
version: s("/hw_version").or_else(|| s("/sw_version")),
- serial: None, // v1/v2 get_psu does not report a serial (V3 does)
+ serial: s("/serial_no"),
voltage_min: None,
voltage_max: None,
output_voltage: None,
diff --git a/vendor/asic-rs-firmwares-whatsminer/src/backends/v2/mod.rs b/vendor/asic-rs-firmwares-whatsminer/src/backends/v2/mod.rs
index 2b340e28..328fb462 100644
--- a/vendor/asic-rs-firmwares-whatsminer/src/backends/v2/mod.rs
+++ b/vendor/asic-rs-firmwares-whatsminer/src/backends/v2/mod.rs
@@ -530,14 +530,15 @@ impl GetWattage for WhatsMinerV2 {
}
fn parse_psu(&self, data: &HashMap<DataField, Value>) -> Option<PsuInfo> {
- // get_psu /Msg -> {model, hw_version, sw_version} (string values). No DC
- // output voltage or rated envelope is exposed, so only identity is set.
+ // get_psu /Msg -> {model, name, hw_version, sw_version, serial_no} (string
+ // values). No DC output voltage or rated envelope is exposed, so only
+ // identity (model/version/serial) is set.
let d = data.get(&DataField::Psu)?;
let s = |k: &str| d.pointer(k).and_then(|v| v.as_str()).filter(|s| !s.is_empty()).map(str::to_string);
let psu = PsuInfo {
model: s("/model").or_else(|| s("/name")),
version: s("/hw_version").or_else(|| s("/sw_version")),
- serial: None, // v1/v2 get_psu does not report a serial (V3 does)
+ serial: s("/serial_no"),
voltage_min: None,
voltage_max: None,
output_voltage: None,
+1 -1
View File
@@ -1 +1 @@
{"$comment":"This file only protects against accidental modifications. It is not a security mechanism and does not protect against malicious changes.","files":{".cargo_vcs_info.json":"de321c89f62a60690ba07d6bb145ac688c6141c458638e68b3ed36b50b8de1f1","Cargo.lock":"5942ec7c9cf5c201bd32442d65020dc3ae72e33cb5aaf374b2a26501571a1487","Cargo.toml":"cb9ee00cbb415fa66a71a7d4822839bb3552336ec9ab975ae7b1137c711449cb","Cargo.toml.orig":"08409c395e4d502015da62e97efdc9c5bc6e3076031144f3f5aa35c900c7c735","src/backends/mod.rs":"26591e67688f8d015242295dde5050c4b34986e9980018a855346291a0472206","src/backends/v1_2_0/mod.rs":"1634197592d962894e330b65a808518734aa26af57f182ea64dca59e3e9eb58b","src/backends/v1_2_0/web.rs":"ac89f16bf623f7d85590d34b45c99b0e522d9d434b4c22af7fa8a8a653e09d2e","src/backends/v1_3_0/mod.rs":"ab0a02f3fe1e6400f07f2bd148cb05e027cfc1e5b1fbfe6f2f01a1dddf78bb51","src/backends/v1_3_0/web.rs":"1ec4cbe6bdc26f165d9e54e9bf2aac4c3706357ce4677dc21113710d4a26c3c1","src/firmware.rs":"168eeffaef90cb1525bb2e126e73905b5205d49215437263813e30323f6b7a05","src/lib.rs":"16ea1c0007fa6d6c86c1f83d3ac9cdf065cd9936cd52f35ef89c227397bbc54a","src/timezone.rs":"309bf23de1bdc9126bde5db8dabff0d2c0fea797dbf2630a772a18539838a05e"},"package":"1cb662e56f104c0fe45c8ccdac13f60cbcaad45ac228f939c6ac46ff40335052"}
{"$comment":"This file only protects against accidental modifications. It is not a security mechanism and does not protect against malicious changes.","files":{".cargo_vcs_info.json":"de321c89f62a60690ba07d6bb145ac688c6141c458638e68b3ed36b50b8de1f1","Cargo.lock":"5942ec7c9cf5c201bd32442d65020dc3ae72e33cb5aaf374b2a26501571a1487","Cargo.toml":"cb9ee00cbb415fa66a71a7d4822839bb3552336ec9ab975ae7b1137c711449cb","Cargo.toml.orig":"08409c395e4d502015da62e97efdc9c5bc6e3076031144f3f5aa35c900c7c735","src/backends/mod.rs":"26591e67688f8d015242295dde5050c4b34986e9980018a855346291a0472206","src/backends/v1_2_0/mod.rs":"a1b0eb9e2e57cad0190eb8f31dafff0999e31c3602db2b8d84e9dd45c955b623","src/backends/v1_2_0/web.rs":"ac89f16bf623f7d85590d34b45c99b0e522d9d434b4c22af7fa8a8a653e09d2e","src/backends/v1_3_0/mod.rs":"9aa230fe942ca775f812300f0041f5565861ef32ad73207e48d02b41e423ee25","src/backends/v1_3_0/web.rs":"1ec4cbe6bdc26f165d9e54e9bf2aac4c3706357ce4677dc21113710d4a26c3c1","src/firmware.rs":"168eeffaef90cb1525bb2e126e73905b5205d49215437263813e30323f6b7a05","src/lib.rs":"16ea1c0007fa6d6c86c1f83d3ac9cdf065cd9936cd52f35ef89c227397bbc54a","src/timezone.rs":"309bf23de1bdc9126bde5db8dabff0d2c0fea797dbf2630a772a18539838a05e"},"package":"1cb662e56f104c0fe45c8ccdac13f60cbcaad45ac228f939c6ac46ff40335052"}
+46 -12
View File
@@ -296,6 +296,16 @@ impl GetDataLocations for VnishV120 {
tag: Some("unit"),
},
),
// Per-board hashboard model ("board_model") from factory-info, which
// the live /chains + /summary do not carry. Already fetched for serial.
(
WEB_FACTORY_INFO,
DataExtractor {
func: get_by_pointer,
key: Some("/chains"),
tag: Some("factory"),
},
),
],
DataField::Chips => vec![(
WEB_CHAINS,
@@ -493,6 +503,11 @@ impl GetHashboards for VnishV120 {
.unwrap_or(HashRateUnit::GigaHash);
let algo = self.device_info.algo;
let chip_chains = data.get(&DataField::Chips).and_then(|v| v.as_array());
// Factory-info chains carry the hashboard model (board_model), keyed by the
// same 1-based chain id. Not present on the live /chains or /summary.
let factory_chains = hashboards_data
.and_then(|v| v.pointer("/factory"))
.and_then(|v| v.as_array());
let mut hashboards: Vec<BoardData> =
(0..self.device_info.hardware.board_count().unwrap_or(0) as usize)
@@ -642,6 +657,16 @@ impl GetHashboards for VnishV120 {
.and_then(|v| v.as_str())
.map(|s| s == "mining")
.or_else(|| board.hashrate.as_ref().map(|h| h.value > 0.0));
// Hashboard model from factory-info (board_model), matched by chain id.
board.hashboard_model = factory_chains.and_then(|chains| {
chains
.iter()
.find(|c| c.pointer("/id").and_then(|v| v.as_u64()) == Some(id))
.and_then(|c| c.pointer("/board_model"))
.and_then(|v| v.as_str())
.filter(|s| !s.is_empty())
.map(String::from)
});
}
hashboards
@@ -919,22 +944,31 @@ impl GetMessages for VnishV120 {
"" | "mining" | "auto-tuning" | "auto_tuning" | "tuning"
);
if red > 0 {
// Severity reflects whether the board is still doing its job. A board
// NOT in a normal mining state is down -> Error (red). A board that is
// still mining but has some failed/degraded chips is sub-optimal, not
// broken -> Warning (yellow): dead chips while the board keeps hashing
// near its target are wear, not a fault (a ~83%-hashrate board must not
// read as broken).
if !state_ok {
let detail = if red > 0 {
format!("Hashboard {id}: {state} ({red} failed chip(s))")
} else {
format!("Hashboard {id}: {state}")
};
messages.push(MinerMessage::with_component(
0,
0,
detail,
MessageSeverity::Error,
Some(MinerComponent::hashboard(idx)),
));
} else if red > 0 {
messages.push(MinerMessage::with_component(
0,
0,
format!("Hashboard {id}: {red} failed chip(s)"),
MessageSeverity::Error,
Some(MinerComponent::hashboard(idx)),
));
} else if !state_ok {
// A board not in a normal state but with no failed chips: report
// the state itself (e.g. "initializing", "disabled", "stopped").
messages.push(MinerMessage::with_component(
0,
0,
format!("Hashboard {id}: {state}"),
MessageSeverity::Error,
MessageSeverity::Warning,
Some(MinerComponent::hashboard(idx)),
));
} else if orange > 0 {
+47 -12
View File
@@ -294,6 +294,17 @@ impl GetDataLocations for VnishV130 {
tag: Some("unit"),
},
),
// Per-board hashboard model ("board_model", e.g. "A3HB70601") from
// the factory-info endpoint, which the live /chains + /summary do not
// carry. Already fetched for the PSU serial.
(
WEB_FACTORY_INFO,
DataExtractor {
func: get_by_pointer,
key: Some("/chains"),
tag: Some("factory"),
},
),
],
DataField::Chips => vec![(
WEB_CHAINS,
@@ -499,6 +510,11 @@ impl GetHashboards for VnishV130 {
.unwrap_or(HashRateUnit::GigaHash);
let algo = self.device_info.algo;
let chip_chains = data.get(&DataField::Chips).and_then(|v| v.as_array());
// Factory-info chains carry the hashboard model (board_model), keyed by the
// same 1-based chain id. Not present on the live /chains or /summary.
let factory_chains = hashboards_data
.and_then(|v| v.pointer("/factory"))
.and_then(|v| v.as_array());
let mut hashboards: Vec<BoardData> =
(0..self.device_info.hardware.board_count().unwrap_or(0) as usize)
@@ -648,6 +664,16 @@ impl GetHashboards for VnishV130 {
.and_then(|v| v.as_str())
.map(|s| s == "mining")
.or_else(|| board.hashrate.as_ref().map(|h| h.value > 0.0));
// Hashboard model from factory-info (board_model), matched by chain id.
board.hashboard_model = factory_chains.and_then(|chains| {
chains
.iter()
.find(|c| c.pointer("/id").and_then(|v| v.as_u64()) == Some(id))
.and_then(|c| c.pointer("/board_model"))
.and_then(|v| v.as_str())
.filter(|s| !s.is_empty())
.map(String::from)
});
}
hashboards
@@ -874,22 +900,31 @@ impl GetMessages for VnishV130 {
"" | "mining" | "auto-tuning" | "auto_tuning" | "tuning"
);
if red > 0 {
// Severity reflects whether the board is still doing its job. A board
// NOT in a normal mining state is down -> Error (red). A board that is
// still mining but has some failed/degraded chips is sub-optimal, not
// broken -> Warning (yellow): dead chips while the board keeps hashing
// near its target are wear, not a fault (a ~83%-hashrate board must not
// read as broken).
if !state_ok {
let detail = if red > 0 {
format!("Hashboard {id}: {state} ({red} failed chip(s))")
} else {
format!("Hashboard {id}: {state}")
};
messages.push(MinerMessage::with_component(
0,
0,
detail,
MessageSeverity::Error,
Some(MinerComponent::hashboard(idx)),
));
} else if red > 0 {
messages.push(MinerMessage::with_component(
0,
0,
format!("Hashboard {id}: {red} failed chip(s)"),
MessageSeverity::Error,
Some(MinerComponent::hashboard(idx)),
));
} else if !state_ok {
// A board not in a normal state but with no failed chips: report
// the state itself (e.g. "initializing", "disabled", "stopped").
messages.push(MinerMessage::with_component(
0,
0,
format!("Hashboard {id}: {state}"),
MessageSeverity::Error,
MessageSeverity::Warning,
Some(MinerComponent::hashboard(idx)),
));
} else if orange > 0 {
+1 -1
View File
@@ -1 +1 @@
{"$comment":"This file only protects against accidental modifications. It is not a security mechanism and does not protect against malicious changes.","files":{".cargo_vcs_info.json":"30f09ad063df45fdf223aff235fe2da15cb1a7e79e86d7012074153b91662fc4","Cargo.lock":"9d0886791db53421d3218ab72d964145b86cfbe9738eaf09aac5d3c89a1c0190","Cargo.toml":"8c2e9938436850f2e250e8268ed7b385fce903e2077923b207a0560ca3e3242c","Cargo.toml.orig":"891fcfa45e79d6bc4d838c4f3075618f791bd013c99231da48e752b987f409d5","src/backends/mod.rs":"0f5a0ae31d5443d0d0f41a2540def806196238c92d22761b3ad9843cb2e77f45","src/backends/v1/mod.rs":"2b1532bad5a75f90bb6556c9856ccb13522935779678eb764dd6de546ee0999d","src/backends/v1/rpc.rs":"72f9b67c2389ab6e9968e0eb340bd2b6aad9aaf059f4429eb31398863bb87f42","src/backends/v2/mod.rs":"b490e6ae2438b798c866800345e25ae1689f0d43237a9c165a2cca9bbe567c40","src/backends/v2/rpc.rs":"52f8d504c236009b020bf33b5550236e36d07b2c73a15bdcfcafa5188e4e1cb6","src/backends/v3/mod.rs":"fe308cc4944a5abbb578a3c87c1538ba189d25fdaae4c06faeb151a3cb5aedc7","src/backends/v3/rpc.rs":"7a5f80aec4af1bcaa0d36e67345aa9acbbd8ead73c0be474f06305358b38e81b","src/error_codes.rs":"b2af610880fb400a9e6297662371a6b3b55077b72cf11115b77fd4d2df44e6a1","src/firmware.rs":"6d002e481ce0a897c0485b9393b0382fcb25811164e893eb8eb67b2ff392ca0d","src/lib.rs":"710b46c9d934f26f900e1366ca1df5f872896e7d8da03569c0f159859e899cc9","src/test/json/mod.rs":"99760925ccfefc40d2455d3567fb1ecfc99e9e55e70478190ef372a954825909","src/test/json/v1/devs.json":"b4fd010f0bae3584efde93387cf2dab5933b499cc30a2dd7635fdc994b56c3b8","src/test/json/v1/get_psu.json":"8c11b6495e0bd5da496dd5c10ca53ec53b2d8fe9a3737f470ec9ce2c1aaf9d99","src/test/json/v1/get_version.json":"c43e947e654792ab191210d50c6f793ee0dd7af41e8cb59f0722b70f32a203bc","src/test/json/v1/mod.rs":"a12ec375a02238d5e26b64e2f7aeb0fc336747d86ae012dc154265ee5afaabbf","src/test/json/v1/pools.json":"b570808a3428a0773d7d2ee322150d8fd0794a33804af970300a7fef128a8a01","src/test/json/v1/status.json":"00ec38dd9f980b7ac0ffd6f815374afdbbed98d601bd8ef18bcf0f76ae0aa853","src/test/json/v1/summary.json":"d6e3e75654eb4019e1f479b3d9cf3097130f1afb85dd3338682c094fd4ab498a","src/test/json/v1/summary_with_errors.json":"1ba682f6ad5c43e41ae22a4069d0f52f04da3f07a18031bf4c07e07b3c59cc97","src/test/json/v2/devs.json":"2d203e41ef6ef337c0c81456b73d08730882c3167403c557c3c9776022a972d1","src/test/json/v2/get_error_code.json":"e90b702fd97bceb4f62dcb8228f75ff5ce930290355dca94eefd7192f7f57009","src/test/json/v2/get_error_code_with_errors.json":"6cb6038366eb3835684421c41be0b2b30ae8ce79a7ed51a85f4f52f70da9df16","src/test/json/v2/get_miner_info.json":"55d2af984833a692f502188ae4df4e41bdc10386b47f921c896a452ef1de9062","src/test/json/v2/get_psu.json":"b43086b65897061521d1f6611e200ef372a1724f9ea1876e347c03d5fb19b8f2","src/test/json/v2/get_version.json":"b17e3a81603b43186b2e15745e6822b6c82b3c6f5928b22f84e683d7728dbfcd","src/test/json/v2/mod.rs":"c847205d076323bbd9698e393d241b08f3cf75d32aae86f7058cf8748266b935","src/test/json/v2/pools.json":"926d34e8dae774473ebfec83d4a38e77ca73231708f07683763e212be7af0580","src/test/json/v2/status.json":"fc268cd23864ef99e84813dbf8eb916b2e6f339351a0ee5dab217cbe02569fc3","src/test/json/v2/summary.json":"4e4c01b986e2960893f58d0f1ea4dce23b8ef88db4985348f7f0183eb4818478","src/test/json/v3/get_device_info.json":"83ac22ea9a11adbceb4c963db80aa62d9a2aa50d019a372394dece817d924cda","src/test/json/v3/get_device_info_with_errors.json":"24cee4b7840e87e12147cbfddf6c361f3b378a15bb85330b339d3be9e17cdbd5","src/test/json/v3/get_miner_status_edevs.json":"2d831c06113f555e0988df994c2e602a053a4aea603dded0db8f0f80e191ca5a","src/test/json/v3/get_miner_status_pools.json":"cd65c2efd3a5ce80b57aae46c420298a34ca06df7ac7f8c36fd556217703d242","src/test/json/v3/get_miner_status_summary.json":"799a94ba13ef54aed0f81a3d041d6c1fa263d4183754b384c69ca12d85a8d3ba","src/test/json/v3/mod.rs":"7ea3a8ff1b81c7a5b0f44f7c12dda880a9aeac5b0e6b56ac4fff4f4a7cbfe451","src/test/mod.rs":"ed52c3d613eabc4a0346bb38bcfdf7a94933d61e368d3c9094821edeab92f81b"},"package":"c85da6325b62f061327dc5f7605dd3721c823a9e8a2cfd6a356363dfbc84d66e"}
{"$comment":"This file only protects against accidental modifications. It is not a security mechanism and does not protect against malicious changes.","files":{".cargo_vcs_info.json":"30f09ad063df45fdf223aff235fe2da15cb1a7e79e86d7012074153b91662fc4","Cargo.lock":"9d0886791db53421d3218ab72d964145b86cfbe9738eaf09aac5d3c89a1c0190","Cargo.toml":"8c2e9938436850f2e250e8268ed7b385fce903e2077923b207a0560ca3e3242c","Cargo.toml.orig":"891fcfa45e79d6bc4d838c4f3075618f791bd013c99231da48e752b987f409d5","src/backends/mod.rs":"0f5a0ae31d5443d0d0f41a2540def806196238c92d22761b3ad9843cb2e77f45","src/backends/v1/mod.rs":"177f88d99ae39eded5f2843df42017855252a10fa2d85b22c1dd2cce73be1290","src/backends/v1/rpc.rs":"72f9b67c2389ab6e9968e0eb340bd2b6aad9aaf059f4429eb31398863bb87f42","src/backends/v2/mod.rs":"ba400e105436c3c0acff002a1a5d1a1f357828d91c81b533120b4452e57a9ed0","src/backends/v2/rpc.rs":"52f8d504c236009b020bf33b5550236e36d07b2c73a15bdcfcafa5188e4e1cb6","src/backends/v3/mod.rs":"fe308cc4944a5abbb578a3c87c1538ba189d25fdaae4c06faeb151a3cb5aedc7","src/backends/v3/rpc.rs":"7a5f80aec4af1bcaa0d36e67345aa9acbbd8ead73c0be474f06305358b38e81b","src/error_codes.rs":"b2af610880fb400a9e6297662371a6b3b55077b72cf11115b77fd4d2df44e6a1","src/firmware.rs":"6d002e481ce0a897c0485b9393b0382fcb25811164e893eb8eb67b2ff392ca0d","src/lib.rs":"710b46c9d934f26f900e1366ca1df5f872896e7d8da03569c0f159859e899cc9","src/test/json/mod.rs":"99760925ccfefc40d2455d3567fb1ecfc99e9e55e70478190ef372a954825909","src/test/json/v1/devs.json":"b4fd010f0bae3584efde93387cf2dab5933b499cc30a2dd7635fdc994b56c3b8","src/test/json/v1/get_psu.json":"8c11b6495e0bd5da496dd5c10ca53ec53b2d8fe9a3737f470ec9ce2c1aaf9d99","src/test/json/v1/get_version.json":"c43e947e654792ab191210d50c6f793ee0dd7af41e8cb59f0722b70f32a203bc","src/test/json/v1/mod.rs":"a12ec375a02238d5e26b64e2f7aeb0fc336747d86ae012dc154265ee5afaabbf","src/test/json/v1/pools.json":"b570808a3428a0773d7d2ee322150d8fd0794a33804af970300a7fef128a8a01","src/test/json/v1/status.json":"00ec38dd9f980b7ac0ffd6f815374afdbbed98d601bd8ef18bcf0f76ae0aa853","src/test/json/v1/summary.json":"d6e3e75654eb4019e1f479b3d9cf3097130f1afb85dd3338682c094fd4ab498a","src/test/json/v1/summary_with_errors.json":"1ba682f6ad5c43e41ae22a4069d0f52f04da3f07a18031bf4c07e07b3c59cc97","src/test/json/v2/devs.json":"2d203e41ef6ef337c0c81456b73d08730882c3167403c557c3c9776022a972d1","src/test/json/v2/get_error_code.json":"e90b702fd97bceb4f62dcb8228f75ff5ce930290355dca94eefd7192f7f57009","src/test/json/v2/get_error_code_with_errors.json":"6cb6038366eb3835684421c41be0b2b30ae8ce79a7ed51a85f4f52f70da9df16","src/test/json/v2/get_miner_info.json":"55d2af984833a692f502188ae4df4e41bdc10386b47f921c896a452ef1de9062","src/test/json/v2/get_psu.json":"b43086b65897061521d1f6611e200ef372a1724f9ea1876e347c03d5fb19b8f2","src/test/json/v2/get_version.json":"b17e3a81603b43186b2e15745e6822b6c82b3c6f5928b22f84e683d7728dbfcd","src/test/json/v2/mod.rs":"c847205d076323bbd9698e393d241b08f3cf75d32aae86f7058cf8748266b935","src/test/json/v2/pools.json":"926d34e8dae774473ebfec83d4a38e77ca73231708f07683763e212be7af0580","src/test/json/v2/status.json":"fc268cd23864ef99e84813dbf8eb916b2e6f339351a0ee5dab217cbe02569fc3","src/test/json/v2/summary.json":"4e4c01b986e2960893f58d0f1ea4dce23b8ef88db4985348f7f0183eb4818478","src/test/json/v3/get_device_info.json":"83ac22ea9a11adbceb4c963db80aa62d9a2aa50d019a372394dece817d924cda","src/test/json/v3/get_device_info_with_errors.json":"24cee4b7840e87e12147cbfddf6c361f3b378a15bb85330b339d3be9e17cdbd5","src/test/json/v3/get_miner_status_edevs.json":"2d831c06113f555e0988df994c2e602a053a4aea603dded0db8f0f80e191ca5a","src/test/json/v3/get_miner_status_pools.json":"cd65c2efd3a5ce80b57aae46c420298a34ca06df7ac7f8c36fd556217703d242","src/test/json/v3/get_miner_status_summary.json":"799a94ba13ef54aed0f81a3d041d6c1fa263d4183754b384c69ca12d85a8d3ba","src/test/json/v3/mod.rs":"7ea3a8ff1b81c7a5b0f44f7c12dda880a9aeac5b0e6b56ac4fff4f4a7cbfe451","src/test/mod.rs":"ed52c3d613eabc4a0346bb38bcfdf7a94933d61e368d3c9094821edeab92f81b"},"package":"c85da6325b62f061327dc5f7605dd3721c823a9e8a2cfd6a356363dfbc84d66e"}
+4 -3
View File
@@ -557,14 +557,15 @@ impl GetWattage for WhatsMinerV1 {
}
fn parse_psu(&self, data: &HashMap<DataField, Value>) -> Option<PsuInfo> {
// get_psu /Msg -> {model, hw_version, sw_version, ...} (values are strings).
// No DC output voltage or rated envelope is exposed, so only identity is set.
// get_psu /Msg -> {model, name, hw_version, sw_version, serial_no, ...}
// (values are strings). No DC output voltage or rated envelope is exposed, so
// only identity (model/version/serial) is set.
let d = data.get(&DataField::Psu)?;
let s = |k: &str| d.pointer(k).and_then(|v| v.as_str()).filter(|s| !s.is_empty()).map(str::to_string);
let psu = PsuInfo {
model: s("/model").or_else(|| s("/name")),
version: s("/hw_version").or_else(|| s("/sw_version")),
serial: None, // v1/v2 get_psu does not report a serial (V3 does)
serial: s("/serial_no"),
voltage_min: None,
voltage_max: None,
output_voltage: None,
+4 -3
View File
@@ -530,14 +530,15 @@ impl GetWattage for WhatsMinerV2 {
}
fn parse_psu(&self, data: &HashMap<DataField, Value>) -> Option<PsuInfo> {
// get_psu /Msg -> {model, hw_version, sw_version} (string values). No DC
// output voltage or rated envelope is exposed, so only identity is set.
// get_psu /Msg -> {model, name, hw_version, sw_version, serial_no} (string
// values). No DC output voltage or rated envelope is exposed, so only
// identity (model/version/serial) is set.
let d = data.get(&DataField::Psu)?;
let s = |k: &str| d.pointer(k).and_then(|v| v.as_str()).filter(|s| !s.is_empty()).map(str::to_string);
let psu = PsuInfo {
model: s("/model").or_else(|| s("/name")),
version: s("/hw_version").or_else(|| s("/sw_version")),
serial: None, // v1/v2 get_psu does not report a serial (V3 does)
serial: s("/serial_no"),
voltage_min: None,
voltage_max: None,
output_voltage: None,