Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .github/actions/setup-capture-decoder/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: Set up capture decoder
description: Install a pinned FFmpeg binary for host capture tests without system package mirrors.
runs:
using: composite
steps:
- name: Install FFmpeg binary wheel
shell: bash
run: |
python3 -m pip install --disable-pip-version-check --only-binary=:all: --no-deps imageio-ffmpeg==0.6.0
decoder_bin="$RUNNER_TEMP/hypercube-ffmpeg-bin"
mkdir -p "$decoder_bin"
ln -sf "$(python3 -c 'import imageio_ffmpeg; print(imageio_ffmpeg.get_ffmpeg_exe())')" "$decoder_bin/ffmpeg"
echo "$decoder_bin" >> "$GITHUB_PATH"
2 changes: 2 additions & 0 deletions .github/workflows/progressive-textures.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ jobs:
- uses: actions/setup-python@v5
with:
python-version: '3.12'
- name: Install capture decoder for host tests
uses: ./.github/actions/setup-capture-decoder
- run: python3 tests/progressive_fixtures.py
- run: python3 -m unittest discover -s tests -p 'test_progressive*.py'
- run: dotnet run --project tests/TextureFamilies.Tests -c Debug
Expand Down
139 changes: 88 additions & 51 deletions .github/workflows/validation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@ concurrency:
permissions:
contents: read
jobs:
validation:
baseline-validation:
name: ${{ matrix.configuration == 'Debug' && 'validation (Debug)' || 'baseline validation (Release)' }}
runs-on: ubuntu-24.04
timeout-minutes: 50
timeout-minutes: 30
strategy:
fail-fast: false
matrix:
Expand All @@ -31,6 +32,8 @@ jobs:
- uses: actions/setup-python@v5
with:
python-version: '3.12'
- name: Install capture decoder for host tests
uses: ./.github/actions/setup-capture-decoder
- name: Test ordered mesh pass contracts
run: dotnet run --project tests/OrderedMeshPasses.Tests -c Release
- name: Build and test packed assets, scheduler and GameCube executable
Expand Down Expand Up @@ -61,63 +64,82 @@ jobs:
--mount "type=bind,src=$PWD,dst=/work" -w /work hypercube-dolphin
python3 tools/dolphin_validation.py out/native-${{ matrix.configuration }}/Game.dol
--disc out/assets/world.iso --logs out/dolphin-${{ matrix.configuration }} --seconds 240
- name: Build performance comparison executable
if: matrix.configuration == 'Release'
env:
PERFORMANCE_SUITE: '1'
run: tools/build_validation.sh
- name: Run nine performance comparisons and progress checks
if: matrix.configuration == 'Release'
run: >-
docker run --rm --init --shm-size=512m --user "$(id -u):$(id -g)"
--mount "type=bind,src=$PWD,dst=/work" -w /work hypercube-dolphin
python3 tools/dolphin_validation.py out/native-performance-Release/Game.dol
--suite performance --disc out/assets/world.iso
--logs out/dolphin-performance-Release --seconds 240
- name: Build frame-phase profiling executable
if: matrix.configuration == 'Release'
env:
PROFILING_SUITE: '1'
run: tools/build_validation.sh
- name: Run sixteen engine/SDK throughput comparisons
if: matrix.configuration == 'Release'
run: >-
docker run --rm --init --shm-size=512m --user "$(id -u):$(id -g)"
--mount "type=bind,src=$PWD,dst=/work" -w /work hypercube-dolphin
python3 tools/dolphin_validation.py out/native-profiling-Release/Game.dol
--suite profiling --disc out/assets/world.iso
--logs out/dolphin-profiling-Release --seconds 360
- name: Build SDK follow-up profiling executable
if: matrix.configuration == 'Release'
env:
SDK_FOLLOWUP_SUITE: '1'
run: tools/build_validation.sh
- name: Run sixteen SDK wait and direct-read comparisons
if: matrix.configuration == 'Release'
run: >-
docker run --rm --init --shm-size=512m --user "$(id -u):$(id -g)"
--mount "type=bind,src=$PWD,dst=/work" -w /work hypercube-dolphin
python3 tools/dolphin_validation.py out/native-sdk-followup-Release/Game.dol
--suite sdk-followup --disc out/assets/world.iso
--logs out/dolphin-sdk-followup-Release --seconds 360
- name: Build texture follow-up profiling executable
if: matrix.configuration == 'Release'
- name: Upload executable, assets, measurements and rendered evidence
if: always()
uses: actions/upload-artifact@v4
with:
name: hypercube-validation-${{ matrix.configuration }}
path: |
out/native-*/Game.dol
out/native-*/Game.elf
out/assets/
out/dolphin-*/*.csv
out/dolphin-*/*.md
out/dolphin-*/*.json
out/dolphin-*/*.png
out/dolphin-*/*.log
out/dolphin-*/user/Logs/
out/dolphin-*/user/Dump/Audio/
retention-days: 14

release-comparisons:
name: release comparisons (${{ matrix.suite }})
runs-on: ubuntu-24.04
# Each capture and its decoding have their own budget. Running all four
# serially alongside baseline validation exceeded the former 50-minute job.
timeout-minutes: 30
strategy:
fail-fast: false
matrix:
include:
- suite: performance
build_flag: PERFORMANCE_SUITE
seconds: 240
- suite: profiling
build_flag: PROFILING_SUITE
seconds: 360
- suite: sdk-followup
build_flag: SDK_FOLLOWUP_SUITE
seconds: 360
- suite: texture-followup
build_flag: TEXTURE_FOLLOWUP_SUITE
seconds: 480
steps:
- uses: actions/checkout@v4
- id: sdk
run: echo "revision=$(cat .sdk-revision)" >> "$GITHUB_OUTPUT"
- uses: actions/checkout@v4
with:
repository: capz/DolphinDotNet
ref: ${{ steps.sdk.outputs.revision }}
path: vendor/sdk
- uses: actions/setup-dotnet@v4
with:
dotnet-version: 8.0.x
- uses: actions/setup-python@v5
with:
python-version: '3.12'
- name: Install capture decoder for host tests
uses: ./.github/actions/setup-capture-decoder
- name: Build and test Release comparison executable
env:
TEXTURE_FOLLOWUP_SUITE: '1'
run: tools/build_validation.sh
- name: Run sixteen clear, wait and aligned-read comparisons
if: matrix.configuration == 'Release'
CONFIGURATION: Release
FIXTURE_RESOLUTION: '48'
run: env "${{ matrix.build_flag }}=1" tools/build_validation.sh
- name: Build Dolphin validation container
run: docker build -t hypercube-dolphin -f tools/Dockerfile.dolphin .
- name: Run comparison and progress checks
run: >-
docker run --rm --init --shm-size=512m --user "$(id -u):$(id -g)"
--mount "type=bind,src=$PWD,dst=/work" -w /work hypercube-dolphin
python3 tools/dolphin_validation.py out/native-texture-followup-Release/Game.dol
--suite texture-followup --disc out/assets/world.iso
--logs out/dolphin-texture-followup-Release --seconds 480
python3 tools/dolphin_validation.py out/native-${{ matrix.suite }}-Release/Game.dol
--suite ${{ matrix.suite }} --disc out/assets/world.iso
--logs out/dolphin-${{ matrix.suite }}-Release --seconds ${{ matrix.seconds }}
- name: Upload executable, assets, measurements and rendered evidence
if: always()
uses: actions/upload-artifact@v4
with:
name: hypercube-validation-${{ matrix.configuration }}
name: hypercube-${{ matrix.suite }}-Release
path: |
out/native-*/Game.dol
out/native-*/Game.elf
Expand All @@ -130,3 +152,18 @@ jobs:
out/dolphin-*/user/Logs/
out/dolphin-*/user/Dump/Audio/
retention-days: 14

release-validation:
name: validation (Release)
needs: [baseline-validation, release-comparisons]
if: always()
runs-on: ubuntu-24.04
timeout-minutes: 5
steps:
- name: Require baseline validation and every Release comparison
env:
BASELINE_RESULT: ${{ needs.baseline-validation.result }}
COMPARISONS_RESULT: ${{ needs.release-comparisons.result }}
run: |
test "$BASELINE_RESULT" = success
test "$COMPARISONS_RESULT" = success
2 changes: 1 addition & 1 deletion .sdk-revision
Original file line number Diff line number Diff line change
@@ -1 +1 @@
dd8a187b9c35d526b479511846a92bef5873fb29
415476f42eddba4c3a01fc81902da60b06280486
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Open **Hypercube.sln** for the engine, runtime adapter, host checks and console

## Build

Requirements: .NET 8, Python 3.10+, Git and Docker.
Requirements: .NET 8, Python 3.10+, Git, Docker and FFmpeg (for capture-decoding tests and comparison tools).

```sh
mkdir -p vendor
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
57 changes: 57 additions & 0 deletions docs/measurements/progressive/phase-five-dolphin.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
{
"artifacts": {
"out/native-progressive-Release/Game.dol": "f5f93cb2a37a779517e769ffc09dbeefa648adcc3519abdc3622f30d14fc452a",
"out/progressive/textures.hcp": "1ad90536c358b56ed773c9f822231fc0026b8765608460a723ba404d131bfcad"
},
"audio": [
{
"activeWindows": 254,
"file": "ID-Game_2026-11-11_13-17-52_dspdump1.wav",
"longestQuietMs": 0,
"seconds": 25.36424378668665
}
],
"coarsePixelFrames": 5,
"fineDualUvPixelFrames": 10,
"hardwarePerformanceClaim": false,
"implementationCommit": "a122bd5b7aad86ba211e6b3dbcd05e389ad6b732",
"last": {
"active32": 0,
"aram32": 0,
"aramHits": 25,
"audioActive": 1,
"cancelled": 26,
"checksum": 17963,
"coarseMask": 15,
"coarseMeanMs": 170,
"coarseReady": 5,
"coldKiB": 14,
"crcFailures": 1,
"deferred": 2,
"detailMask": 0,
"detailMeanMs": 210,
"detailReady": 7,
"failures": 2,
"frame": 1507,
"frame95ms": 17,
"frame99ms": 17,
"magic": 18516,
"maxPumpUs": 2382,
"peakKiB": 652,
"phase": 10,
"poolBytes": 0,
"publications": 8,
"readBufferKiB": 0,
"retired32": 0,
"retirements": 8,
"stale": 25,
"storageKiB": 1190,
"upload32": 0,
"uploadedKiB": 1171
},
"pixelPatches": 12,
"platform": "Dolphin",
"sampledFrames": 252,
"sdkRevision": "415476f42eddba4c3a01fc81902da60b06280486",
"validationScope": "Dolphin correctness and ownership regression; no physical-console performance or measured page/atlas strategy comparison claim."
}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading