name: wai-quantum extension points # The registry (wai/wai-quantum/src/engine/registry/): the traits a simulation # method, a compiler pass, a noise channel and a program format implement, the # built-ins registered through them, and a host's own registered beside them. # The registry's tests hold every built-in to the bytes it gave (the pinned # job digests, through the built-in registry and through one holding a host's # components), auto to the order it always tried, the built-in channels and # passes to what they declare, and a host's method, pass, channel and format # to what the engine checks of them: each refusal with its code, and its # identity sealed in the receipt of every result it took part in, marked as # registered. A compile's certificate (wai/extensions/quantum-compile.md) is # held beside them: its tests by name, and the vectors of # wai/quantum-conformance/compile/, whose pinned bytes are the same natively # and under wasip2. They run under the full feature set and under the contract # workflow's, natively on both Linux architectures and under wasm32-wasip2 by # wasmtime. The example written outside the engine against its public traits # (wai/wai-quantum/examples/extension_points.rs) is tested and run end to end. concurrency: group: ${{ github.workflow }}-${{ github.event_name == 'push' && github.sha || github.ref }} cancel-in-progress: true on: push: branches: [main] paths: - 'wai/wai-quantum/**' - 'wai/quantum-conformance/native/**' - 'wai/quantum-conformance/compile/**' - 'wai/quantum-conformance/tools/compile_form.py' - 'rust-toolchain.toml' - '.github/workflows/wai-quantum-registry.yml' pull_request: paths: - 'wai/wai-quantum/**' - 'wai/quantum-conformance/native/**' - 'wai/quantum-conformance/compile/**' - 'wai/quantum-conformance/tools/compile_form.py' - 'rust-toolchain.toml' - '.github/workflows/wai-quantum-registry.yml' jobs: relevant: name: does this change touch it runs-on: gate outputs: run: ${{ steps.gate.outputs.run }} steps: - uses: actions/checkout@v5 with: fetch-depth: 0 - id: gate run: | set -euo pipefail r=$(python3 scripts/pr-touches-paths.py .github/workflows/wai-quantum-registry.yml \ "${{ github.event.pull_request.base.sha }}" \ "${{ github.event.pull_request.head.sha }}") echo "this change touches the registry: $r" echo "run=$r" >> "$GITHUB_OUTPUT" native: name: the registry and the example ยท ${{ matrix.runner }} needs: relevant if: needs.relevant.outputs.run == 'true' strategy: fail-fast: false matrix: runner: [linux, linux-arm64] runs-on: ${{ matrix.runner }} timeout-minutes: 60 steps: - uses: actions/checkout@v5 - name: Install Rust 1.99.1 shell: bash run: | export PATH="$HOME/.cargo/bin:$PATH" command -v rustup >/dev/null 2>&1 || \ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --profile minimal --default-toolchain 1.99.1 rustup toolchain install 1.99.1 --profile minimal rustup default 1.99.1 echo "$HOME/.cargo/bin" >> "$GITHUB_PATH" # A module filter is satisfied by any one test of the module, so each # test is required by name to have run. - name: The registry's tests, under the full feature set and the contract's shell: bash working-directory: wai/wai-quantum run: | set -euo pipefail cargo test --locked --release --features full --lib engine::registry:: 2>&1 | tee "$RUNNER_TEMP/full.log" cargo test --locked --release --no-default-features --features quantum_engine,quantum_receipt,quantum_qec,quantum_noise --lib engine::registry:: 2>&1 | tee "$RUNNER_TEMP/contract.log" for log in full contract; do grep -qE '^test result: ok\. 13 passed; 0 failed' "$RUNNER_TEMP/$log.log" || { echo "::error::the registry's tests did not all pass ($log)"; exit 1; } for t in every_built_in_registers_through_its_trait_in_a_fixed_order \ auto_tries_the_built_ins_in_the_order_it_did \ the_pinned_jobs_give_their_bytes_through_any_registry \ the_built_in_channels_are_valid_channels \ the_built_in_passes_give_what_they_declare \ a_registered_method_is_planned_run_and_named_in_its_result \ the_receipt_seals_a_registered_component_s_identity \ registration_refuses_what_it_cannot_hold \ a_registered_method_s_result_is_held_to_the_contract \ a_registered_channel_runs_on_the_density_matrix_and_is_refused_elsewhere \ a_registered_pass_is_checked_by_the_engine \ a_registered_front_end_converts_and_feeds_a_job \ a_built_in_s_declaration_is_what_its_trait_says; do grep -q "^test engine::registry::tests::$t \.\.\. ok$" "$RUNNER_TEMP/$log.log" || { echo "::error::$t did not run ($log)"; exit 1; } done done - name: Device targets and native programs, the xx basis and computational resonators among them shell: bash working-directory: wai/wai-quantum run: | set -euo pipefail # The compiler to each basis (prx rz xx among them) and through a star's # resonator, each program checked under both of a move's phases; the # targets that import, place, model and run them; and the native vectors # (wai/quantum-conformance/native/), each program pinned and proved the # circuit's unitary by the engine's equivalence check, or refused as it says. cargo test --locked --release --features full --lib -- quantum_toolchain::native:: engine::targets:: 2>&1 | tee "$RUNNER_TEMP/targets.log" grep -qE '^test result: ok\. [1-9][0-9]* passed; 0 failed' "$RUNNER_TEMP/targets.log" || { echo "::error::the native compiler's or the targets' tests did not pass"; exit 1; } for t in quantum_toolchain::native::tests::the_xx_basis_writes_each_cz_as_one_fully_entangling_xx \ quantum_toolchain::native::tests::a_cz_through_a_resonator_is_move_cz_move \ quantum_toolchain::native::tests::random_circuits_route_through_a_resonator \ quantum_toolchain::native::tests::the_resonator_discipline_refuses_what_a_move_cannot_do \ quantum_toolchain::native::tests::an_xx_or_prx_angle_out_of_its_range_is_refused \ engine::targets::tests::the_engine_s_equivalence_check_proves_the_xx_and_move_decompositions \ engine::targets::tests::xx_and_star_targets_compile_exactly_and_reproduce_the_ideal_distribution \ engine::targets::tests::a_star_target_routes_through_its_most_reliable_mover \ engine::targets::tests::star_and_xx_documents_import_and_round_trip \ engine::targets::tests::every_built_in_target_reads_round_trips_and_keeps_its_hash; do grep -q "^test $t \.\.\. ok$" "$RUNNER_TEMP/targets.log" || { echo "::error::$t did not run"; exit 1; } done cargo test --locked --release --features full --test native_conformance 2>&1 | tee "$RUNNER_TEMP/native.log" grep -q '^test every_native_vector_compiles_is_proved_or_is_refused_as_it_says \.\.\. ok$' "$RUNNER_TEMP/native.log" || { echo "::error::the native vectors did not pass"; exit 1; } - name: Compiles and their certificates shell: bash working-directory: wai/wai-quantum run: | set -euo pipefail # A certificate as a chain of digests with each pass's layer and distance # (wai/extensions/quantum-compile.md): the form any reader holds it to, a # verifier's second look at a sealed compile and at a job that ran compiled, # unitaries multiplied out in exact arithmetic, and two-qubit blocks around a # device basis's own gate; each test by name. Then the vectors # (wai/quantum-conformance/compile/): every compile to the bytes pinned, every # forged certificate refused as it says. The T count lowered past phase folding # (engine::synth::phasepoly, the pass phase_resynth): regions proved in integers, # the searches holding the signature, and the table of quantum-compile 7.5. cargo test --locked --release --features full --lib -- engine::certificate:: engine::synth::exact:: engine::synth::native2q:: engine::synth::phasepoly:: engine::compile::tests::a_device_basis engine::compile::tests::a_lowering engine::compile::tests::t_count_reduction engine::compile::tests::phase_folding_is_also engine::compile::tests::the_t_count_reductions 2>&1 | tee "$RUNNER_TEMP/certificate.log" grep -qE '^test result: ok\. [1-9][0-9]* passed; 0 failed' "$RUNNER_TEMP/certificate.log" || { echo "::error::the certificate's tests did not pass"; exit 1; } for t in engine::certificate::tests::every_certificate_is_a_chain_from_the_program_to_the_output \ engine::certificate::tests::the_whole_compile_stands_on_the_strongest_layer_that_decides_it \ engine::certificate::tests::a_verifier_compiles_a_sealed_compile_again_and_refuses_a_certificate_the_request_does_not_bear_out \ engine::certificate::tests::another_engine_s_certificate_is_held_to_the_program_where_a_check_decides \ engine::certificate::tests::a_job_that_ran_compiled_carries_the_chain_and_is_held_to_it \ engine::certificate::tests::a_compile_sealed_by_an_earlier_engine_still_verifies \ engine::certificate::tests::a_verifier_compiles_again_only_within_its_bounds \ engine::synth::exact::tests::every_exact_matrix_is_the_reader_s_gate \ engine::synth::exact::tests::every_lowering_in_the_ring_is_proved \ engine::synth::exact::tests::equality_up_to_a_global_phase_is_decided_exactly \ engine::synth::native2q::tests::every_two_qubit_unitary_takes_at_most_three_of_each_entangler \ engine::synth::native2q::tests::the_count_is_the_coordinates_that_are_not_zero \ engine::synth::native2q::tests::gate_by_gate_writes_each_gate_in_the_entangler \ engine::compile::tests::a_device_basis_writes_each_pair_s_block_around_its_own_two_qubit_gate \ engine::compile::tests::a_lowering_in_the_ring_is_proved_and_another_is_measured \ engine::synth::phasepoly::tests::the_seven_parities_of_ccz_are_ccz \ engine::synth::phasepoly::tests::two_regions_are_the_same_exactly_when_their_coefficients_and_maps_are \ engine::synth::phasepoly::tests::two_doubly_controlled_zs_sharing_controls_take_seven_t_gates \ engine::synth::phasepoly::tests::every_reduced_circuit_is_its_circuit_and_never_takes_more_t_gates \ engine::synth::phasepoly::tests::the_searches_keep_the_signature_and_the_whole_search_finds_the_fewest \ engine::synth::phasepoly::tests::a_reordering_is_held_to_each_qubit_s_order \ engine::compile::tests::t_count_reduction_is_proved_and_recorded_in_the_chain \ engine::compile::tests::phase_folding_is_also_proved_in_the_ring_where_it_changes_the_circuit \ engine::compile::tests::the_t_count_reductions_are_the_table_the_specification_gives; do grep -q "^test $t \.\.\. ok$" "$RUNNER_TEMP/certificate.log" || { echo "::error::$t did not run"; exit 1; } done cargo test --locked --release --features full --test compile_conformance 2>&1 | tee "$RUNNER_TEMP/compile-vectors.log" grep -q '^test every_compile_vector_gives_the_bytes_pinned_and_every_forged_certificate_is_refused \.\.\. ok$' "$RUNNER_TEMP/compile-vectors.log" || { echo "::error::the compile vectors did not pass"; exit 1; } # The form's second implementation (Python, from the specification's text): the # pinned certificate holds to the ten rules, each forged vector that names a # rule breaks it, and each that names none leaves the form holding; and every # rotation vector's word, multiplied out in integers, is as far from its rotation # as its pinned distance rounded up. SUDO=""; [ "$(id -u)" -ne 0 ] && SUDO="sudo" command -v python3 >/dev/null || { $SUDO apt-get update -qq; $SUDO apt-get install -y -qq python3; } python3 -I ../quantum-conformance/tools/compile_form.py --selftest python3 -I ../quantum-conformance/tools/compile_form.py --vectors ../quantum-conformance/compile | tee "$RUNNER_TEMP/compile-form.log" grep -q '^compile_form: certificate.json holds together; 14 forged vectors each break the rule they name' "$RUNNER_TEMP/compile-form.log" || { echo "::error::the form's second implementation did not hold the vectors"; exit 1; } grep -q '^compile_form: 20 rotations, each word Clifford+T with the T count pinned, unitary in exact arithmetic' "$RUNNER_TEMP/compile-form.log" || { echo "::error::the second implementation did not hold the rotation vectors"; exit 1; } - name: The built-ins' bytes, the refusal table, the job layer and the planner under a contract beside them shell: bash working-directory: wai/wai-quantum run: | set -euo pipefail cargo test --locked --release --features full --lib -- engine::job:: engine::refusal:: engine::catalog:: engine::compile:: engine::formats:: engine::planner:: 2>&1 | tee "$RUNNER_TEMP/engine.log" grep -qE '^test result: ok\. [1-9][0-9]* passed; 0 failed' "$RUNNER_TEMP/engine.log" || { echo "::error::the engine's tests did not pass"; exit 1; } for t in engine::job::tests::a_job_that_asks_for_no_verdict_gives_the_bytes_it_gave \ engine::refusal::tests::the_documented_table_is_the_table \ engine::planner::tests::what_the_routes_cost_is_the_same_bytes_on_every_host \ engine::planner::tests::nothing_falls_back_from_exact_to_approximate \ engine::planner::tests::nothing_falls_back_between_a_simulator_and_a_device \ engine::planner::tests::every_rule_a_verifier_holds_a_local_contract_job_to_is_broken_once_and_found_alone \ engine::planner::tests::every_rule_a_verifier_holds_a_provider_s_contract_job_to_is_broken_once_and_found_alone \ engine::planner::tests::an_energy_ceiling_is_held_by_a_live_reading_and_a_stopped_run_says_so \ engine::planner::tests::a_shadow_is_a_method_s_run_of_exactly_the_job_s_program \ engine::planner::tests::a_shadow_the_host_says_failed_is_run_again \ engine::planner::tests::under_a_contract_a_provider_is_used_only_where_it_allows_one \ engine::planner::tests::what_a_price_may_state_is_bounded_and_past_it_is_an_unknown \ engine::planner::tests::a_local_route_is_free_and_kept_states_exactly_the_charge \ engine::planner::tests::auto_is_what_the_routes_give_and_cannot_be_lowered \ engine::planner::tests::a_device_target_s_job_names_its_method_beside_the_host_s_providers \ engine::planner::tests::a_named_approximate_simulator_runs_under_a_contract_that_names_no_class \ engine::planner::tests::the_sampling_bound_holds_for_sparse_and_dense_outcomes \ engine::planner::tests::a_named_provider_s_routes_carry_the_class_their_shadow_has \ engine::planner::tests::a_built_in_route_and_a_result_are_held_to_their_method_s_classes \ engine::planner::tests::what_a_receipt_states_of_itself_is_of_its_form \ engine::planner::tests::recheck_plans_the_shadow_again_and_leaves_the_host_s_routes_to_the_host \ engine::planner::tests::a_target_s_and_a_pulse_program_s_deadline_is_reported_kept; do grep -q "^test $t \.\.\. ok$" "$RUNNER_TEMP/engine.log" || { echo "::error::$t did not run"; exit 1; } done # A gate held whole through a job, and the meter that holds a matrix # product job, each test by name. for t in engine::catalog::whole_tests::what_takes_standard_gates_gives_what_it_gave \ engine::catalog::whole_tests::a_job_on_the_state_vectors_holds_the_gate_whole \ engine::catalog::whole_tests::the_bit_exact_method_keeps_its_bits_unless_asked \ engine::catalog::whole_tests::a_job_can_ask_for_standard_gates \ engine::catalog::whole_tests::every_other_method_takes_standard_gates \ engine::catalog::whole_tests::past_the_standard_form_only_the_state_vectors_take_it \ engine::catalog::whole_tests::a_gate_in_a_program_that_measures_runs_whole \ engine::catalog::whole_tests::a_verdict_holds_a_whole_run_to_its_intent \ engine::catalog::whole_tests::a_registered_method_sees_standard_gates \ engine::catalog::whole_tests::a_bit_exact_result_states_its_global_phase \ engine::catalog::whole_tests::an_angle_below_the_table_is_stated \ engine::catalog::whole_tests::a_named_matrix_product_job_is_held_to_the_bond_it_reaches \ engine::catalog::whole_tests::a_gate_too_large_for_standard_gates_is_refused_before_they_are_written \ engine::catalog::whole_tests::a_tiny_phase_under_many_controls_is_not_read_as_clifford \ engine::catalog::whole_tests::a_verdict_with_no_intent_holds_a_run_past_the_standard_form \ engine::catalog::whole_tests::a_named_method_on_standard_gates_refuses_as_the_reader_does \ engine::catalog::whole_tests::lint_counts_a_program_s_steps_in_standard_gates \ engine::catalog::whole_tests::the_refusal_past_16_controls_names_the_option \ engine::catalog::whole_tests::options_controls_is_read_and_not_ignored \ engine::catalog::whole_tests::the_stated_phase_is_relative_to_the_state_vector \ engine::catalog::whole_tests::the_bit_exact_whole_form_gives_the_state_vector_s_amplitudes \ engine::catalog::whole_tests::a_bit_exact_result_s_accuracy_members_hold_what_they_say \ engine::catalog::whole_tests::the_meter_stops_a_job_that_passes_its_budget \ engine::catalog::whole_tests::a_metered_plan_states_the_work_its_meter_allows \ engine::catalog::tests::the_mps_plan_bounds_its_run; do grep -q "^test $t \.\.\. ok$" "$RUNNER_TEMP/engine.log" || { echo "::error::$t did not run"; exit 1; } done cargo test --locked --release --features full --lib -- quantum_mpsim:: quantum_sv::tests::a_gate_under_controls quantum::tests::the_walk_under_controls 2>&1 | tee "$RUNNER_TEMP/meter.log" for t in quantum_mpsim::tests::the_meter_counts_the_bonds_reached_and_changes_nothing \ quantum_mpsim::tests::the_meter_charges_each_move_of_the_center \ quantum_mpsim::tests::a_far_gate_stops_at_the_update_that_passes_the_budget \ quantum_mpsim::tests::an_update_is_priced_at_the_bond_it_spans \ quantum_mpsim::tests::the_bound_holds_the_meter \ quantum_sv::tests::a_gate_under_controls_is_its_dense_gate_on_any_thread_count \ quantum_sv::tests::a_gate_under_controls_must_fit_the_register \ quantum::tests::the_walk_under_controls_gives_the_scan_s_bits; do grep -q "^test $t \.\.\. ok$" "$RUNNER_TEMP/meter.log" || { echo "::error::$t did not run"; exit 1; } done - name: The example, tested and run shell: bash working-directory: wai/wai-quantum run: | set -euo pipefail cargo test --locked --release --features quantum_engine,quantum_receipt --example extension_points 2>&1 | tee "$RUNNER_TEMP/example.log" grep -qE '^test result: ok\. 3 passed; 0 failed' "$RUNNER_TEMP/example.log" || { echo "::error::the example's tests did not pass"; exit 1; } cargo run --locked --release --features quantum_engine,quantum_receipt --example extension_points > "$RUNNER_TEMP/walk.txt" cat "$RUNNER_TEMP/walk.txt" for want in 'the job planned on "basis_table"' 'counts {"100":100}' '"origin": "registered"'; do grep -qF "$want" "$RUNNER_TEMP/walk.txt" || { echo "::error::the example's walk-through does not say: $want"; exit 1; } done wasip2: name: the registry under wasm32-wasip2 (wasmtime) needs: relevant if: needs.relevant.outputs.run == 'true' runs-on: linux timeout-minutes: 60 steps: - uses: actions/checkout@v5 - name: Install Rust 1.99.1 with the wasm32-wasip2 target shell: bash run: | export PATH="$HOME/.cargo/bin:$PATH" command -v rustup >/dev/null 2>&1 || \ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --profile minimal --default-toolchain 1.99.1 rustup toolchain install 1.99.1 --profile minimal rustup default 1.99.1 rustup target add --toolchain 1.99.1 wasm32-wasip2 echo "$HOME/.cargo/bin" >> "$GITHUB_PATH" # The release binary, pinned by version and SHA-256, rather than a build from source. # Every WAI workflow that runs wasmtime pins this one version, and every run passes # -W nan-canonicalization=y -W relaxed-simd-deterministic=y: every NaN a float # instruction makes is the canonical one, and each relaxed SIMD instruction has one # behaviour on every host. A stock wasmtime leaves both off. The fixed relaxed # behaviour is the engine's own: on 50.0.1 relaxed_madd is fused (measured on arm64 and # x86_64), where WebAssembly's deterministic profile prescribes the unfused result. # The repository checks (scripts/check-wasmtime-pin.py) fail a workflow that pins another # release or runs wasmtime without both settings. - name: Install wasmtime 50.0.1 shell: bash run: | set -euo pipefail [ "$(uname -m)" = x86_64 ] || { echo "::error::the pinned wasmtime archive is x86_64; this host is $(uname -m)"; exit 1; } if ! command -v xz >/dev/null 2>&1; then SUDO=""; [ "$(id -u)" -ne 0 ] && SUDO="sudo" $SUDO apt-get update -qq $SUDO apt-get install -y -qq xz-utils fi v=50.0.1 f="wasmtime-v$v-x86_64-linux.tar.xz" curl --proto '=https' --tlsv1.2 -sSfL -o "$RUNNER_TEMP/$f" \ "https://github.com/bytecodealliance/wasmtime/releases/download/v$v/$f" echo "685466455dd42a14774a86c36c8f2e45cbb9bd6d92a850139315df60a75498a5 $RUNNER_TEMP/$f" | sha256sum -c - tar -xJf "$RUNNER_TEMP/$f" -C "$RUNNER_TEMP" echo "$RUNNER_TEMP/wasmtime-v$v-x86_64-linux" >> "$GITHUB_PATH" # A debug build, so integer overflow panics instead of wrapping. - name: The registry's tests under wasmtime shell: bash working-directory: wai/wai-quantum env: CARGO_TARGET_WASM32_WASIP2_RUNNER: wasmtime run -W nan-canonicalization=y -W relaxed-simd-deterministic=y run: | set -euo pipefail cargo test --locked --target wasm32-wasip2 --features full --lib engine::registry:: 2>&1 | tee "$RUNNER_TEMP/wasip2.log" grep -qE '^test result: ok\. 13 passed; 0 failed' "$RUNNER_TEMP/wasip2.log" || { echo "::error::the registry's tests did not all pass under wasip2"; exit 1; } # The compile vectors (wai/quantum-conformance/compile/) are compiled into their # test: the same pinned bytes here as natively. cargo test --locked --release --target wasm32-wasip2 --features full --test compile_conformance 2>&1 | tee "$RUNNER_TEMP/wasip2-compile.log" grep -q '^test every_compile_vector_gives_the_bytes_pinned_and_every_forged_certificate_is_refused \.\.\. ok$' "$RUNNER_TEMP/wasip2-compile.log" || { echo "::error::the compile vectors did not pass under wasip2"; exit 1; } # The browser's engine runs a gate under controls by this path too. cargo test --locked --target wasm32-wasip2 --features full --lib quantum_sv::tests::a_gate_under_controls 2>&1 | tee "$RUNNER_TEMP/wasip2-sv.log" for t in quantum_sv::tests::a_gate_under_controls_is_its_dense_gate_on_any_thread_count \ quantum_sv::tests::a_gate_under_controls_must_fit_the_register; do grep -q "^test $t \.\.\. ok$" "$RUNNER_TEMP/wasip2-sv.log" || { echo "::error::$t did not run under wasip2"; exit 1; } done