Skip to content

Follow up fixes for pinning hardware device - #678

Merged
melody-ren merged 10 commits into
NVIDIA:mainfrom
melody-ren:melodyr/pin-device-fixes
Jul 13, 2026
Merged

Follow up fixes for pinning hardware device#678
melody-ren merged 10 commits into
NVIDIA:mainfrom
melody-ren:melodyr/pin-device-fixes

Conversation

@melody-ren

@melody-ren melody-ren commented Jul 11, 2026

Copy link
Copy Markdown
Collaborator

Summary:

  • Worker threads in the decoding server now pin themselves to the decoder's cuda_device_id before serving. Construction only pinned the registry thread, so every worker was decoding on the default device regardless of the pin prior to this patch.
  • The direct call path (no realtime session) had the same problem: configure_decoders leaves the thread on the last decoder's device, so decoder 0 would decode on decoder N's GPU. Each decode now selects its own decoder's device first.
  • If a pin can't be honored we fail instead of decoding on the wrong device: a worker that can't pin aborts server startup, and a cudaSetDevice failure during dispatch returns an error response instead of logging a warning and carrying on.
  • Hololink: HOLOLINK_GPU_ID and cuda_device_id both name the GPU the FPGA is attached to, so they must agree. Either one alone selects the device; setting both to different values throws at transport creation. Single decoder only, same as the rest of the gpu_roce path.
  • Nothing changes if cuda_device_id is not set.
  • Decoder construction is transactional: if a plugin constructor throws after its device was selected, the calling thread's CUDA device is restored to its previous value instead of being left on the failed decoder's device. Originally first introduced in Enforce decoder GPU ownership in the realtime server #687. Adopting the change here.

Outdated: This is a follow-up PR to #664, which should be merged before this PR

This PR depends on #690

kvmto and others added 5 commits July 9, 2026 17:31
Decoders can now be pinned to a specific CUDA device at construction
via a cuda_device_id parameter, settable through C++/Python kwargs
and the YAML realtime config (top-level decoder field, next to type/
transport).

Model: one thread owns one decoder. decoder::get() validates the id
(negative or >= device count throws), persistently pins the
constructing thread with cudaSetDevice (no restore), strips the key
before the plugin constructor, and stores it (get_cuda_device_id()).
Plugin constructors therefore allocate on the right device with zero
plugin changes -- this covers trt_decoder and the closed-source
nv-qldpc-decoder transparently.

decode_async() is the one exception: its fresh std::async worker pins
itself for the call's duration via a lib-private RAII CudaDeviceGuard
(libs/qec/lib/hardware_guards.h).

The realtime host dispatcher (one thread serving all decoders) applies
each decoder's device with set-if-different before enqueue and before
DEVICE-mode graph capture; no-op for unpinned decoders.

Tests: 7 C++ unit tests incl. 2-GPU placement and async-worker pinning,
YAML round-trip + prepare_decoder_params coverage, Python kwargs tests.

NUMA/mempolicy/cpu_affinity and thread-binding APIs are deferred to a
follow-up PR per review feedback on NVIDIA#634.

Signed-off-by: kvmto <kmato@nvidia.com>
cuda_device_id pinned only the constructing thread, so two dispatch
paths decoded on whatever device was current:

- decoding-server DecodingSession workers start unpinned; every
  session decoded on the default device regardless of its pin. The
  worker now pins itself once at worker_loop entry.
- the direct (no realtime session) path decodes on the caller thread,
  which configure_decoders leaves on the LAST decoder's device. It now
  selects the decoder's device before each decode.

Both paths share a new fail-fast helper (hardware_guards.h,
set-if-different, throws). apply_decoder_cuda_device also uses it now:
a cudaSetDevice failure previously warned and continued on the wrong
device; it now surfaces as a dispatch error response, and graph
capture aborts during initialization.

Signed-off-by: Melody Ren <melodyr@nvidia.com>
Two paths could previously run with a decoder's cuda_device_id silently
violated -- the worst failure mode, because decoding can still succeed
on the wrong GPU with nothing but an unread log line as evidence:

- DecodingSession workers logged a cudaSetDevice failure and kept
  serving. The pin now runs on the worker thread behind a
  promise/future handshake in start_worker(): the worker either starts
  pinned or the exception is rethrown on the registry thread and
  server startup aborts, the same channel as a decoder that fails to
  construct.
- gpu_roce chose its GPU from HOLOLINK_GPU_ID (default 0) with no
  knowledge of the decoder's pin, splitting graph capture (pinned
  device) from ring buffers and device-side graph launch (env device).
  Both knobs name the same topology fact -- the FPGA-affine GPU -- so
  they are now reconciled at transport creation: agreement or a single
  set knob resolves the device, a conflict throws, and an unset
  environment defers to the decoder's pin.

The reconciliation is a plain function compiled in every configuration
and unit-tested; the gpu_roce call site remains behind
CUDAQ_GPU_ROCE_AVAILABLE and needs hardware validation.

Signed-off-by: Melody Ren <melodyr@nvidia.com>
- set_cuda_device_for_decode: -1 is a no-op and an impossible device id
  throws -- both runnable on GPU-less CI (cudaSetDevice past the device
  count fails there too), covering the failure transport the worker
  handshake rides on, which cannot be induced end-to-end after
  construction-time validation.
- DecodingSession handshake smoke: a decoder pinned to device 0 starts
  its worker through the promise/future handshake and serves a queued
  item (skips below 1 GPU).

Signed-off-by: Melody Ren <melodyr@nvidia.com>
@melody-ren
melody-ren force-pushed the melodyr/pin-device-fixes branch from e0fda65 to 310fdff Compare July 11, 2026 05:13
- Add the handshake failure-injection test: cuda_device_id_ is
  protected, so a test decoder can carry an impossible id past the
  construction-time range check, and start_worker() must throw and
  join the worker. This is the test that fails if the handshake ever
  reverts to log-and-continue.
- Select the decoder's device on the get_corrections and reset paths
  (host dispatcher and direct call), not just enqueue: a plugin's
  clear_corrections or reset_decoder may touch device memory, and
  interleaved pinned decoders left the wrong device current.
- On the direct path, pin before the syndrome-capture callback so a
  pin failure cannot record a round in a --save_syndrome trace that
  was never decoded. Session-forwarded requests still capture before
  forwarding and still skip the pin.
- Reject a negative HOLOLINK_GPU_ID in the gpu_roce reconciler
  instead of resolving to a garbage device.
- Join already-started workers before the transports are destroyed
  when a constructor that installs transports first fails mid
  load_from_config; drop a dead include.

Signed-off-by: Melody Ren <melodyr@nvidia.com>
@copy-pr-bot

copy-pr-bot Bot commented Jul 13, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

kvmto added a commit to kvmto/cudaqx that referenced this pull request Jul 13, 2026
Merge Melody Ren's decoder pinning follow-up so its production-tested fixes remain in history with their original authorship and this work becomes a true descendant of PR NVIDIA#678.

Adopt the shared fail-fast CUDA device-selection helper, the decoding-session worker startup handshake, explicit HOLOLINK_GPU_ID tracking, and the tested GPU RoCE device-reconciliation contract.

Retain the additional decoder-server ownership guarantees from this branch: select the owning device across enqueue, correction, and reset operations; restore configuration threads after decoder
    construction; and perform CUDA graph capture, scheduler initialization, graph release, decoder destruction, and transport teardown on the owning device.

Resolve GPU RoCE placement before decoder construction so graph capture and transport allocation cannot land on different devices. Reject conflicting environment and decoder placement, explicitly
    negative device IDs, and ambiguous graph-dispatch configurations.

Combine Melody's CI-runnable reconciliation and worker-handshake coverage with the stronger multi-GPU execution, realtime dispatch, and device-correct teardown tests from this branch.

Signed-off-by: kvmto <kmato@nvidia.com>
@melody-ren

Copy link
Copy Markdown
Collaborator Author

/ok to test 3b156de

melody-ren added a commit that referenced this pull request Jul 13, 2026
Carrying the content of #664 , and its commit
7fe9529 in which the `cuda_device_id`
knob was introduced. This PR is meant to revert 664's scope change
introduced by 19b95bf.

This PR should be followed by #678 to enable support for the decoding
server.

PR description copied verbatim from #664 :
## Summary

First PR of the #634 split (per @bmhowe23's review): `cuda_device_id`
only — GPU decoder pinning, settable at construction via kwargs and the
YAML realtime config. NUMA/mempolicy/cpu_affinity and thread-binding
APIs are deferred to a follow-up draft PR (next release), Python
interfaces for those to a third.

## What it does

- **`decoder::get()`** reads and validates `cuda_device_id` (negative or
>= device count → `std::runtime_error`), **persistently pins the
constructing thread** (`cudaSetDevice`, no restore), strips the key
before the plugin constructor, and stores it (`get_cuda_device_id()`, -1
= unpinned).
- **Model: one thread owns one decoder.** The thread that creates a
decoder drives its decode calls; construction-time and lazy decode-time
allocations all land on the pinned device with **zero plugin changes** —
covers `trt_decoder` and the closed-source `nv-qldpc-decoder`
transparently. This addresses the lazily-allocating-decoder concern from
the #634 review without per-call guards or new decode entry points.
- **`decode_async()`** is the sole exception: its fresh `std::async`
worker pins itself for the call's duration via a lib-private RAII
`CudaDeviceGuard` (`libs/qec/lib/hardware_guards.h`, header-only; PR2
extends it).
- **YAML realtime config:** `cuda_device_id` is a top-level
`decoder_config` field (next to `type`/`transport` — placement knob
common to any GPU decoder, not a per-decoder algorithm arg). Surfaced by
`prepare_decoder_params()` for every decoder type; also exposed as
`decoder_config.cuda_device_id` in Python.
- **Realtime session:** the host dispatcher (one thread, all decoders)
applies each decoder's device set-if-different (no restore) before
enqueue and before DEVICE-mode graph capture; no-op for unpinned
decoders.
- **Python kwargs** work with no binding changes:
`qec.get_decoder("trt_decoder", H, cuda_device_id=1)`.

To place N decoders on N GPUs, create each decoder on its own thread
(`std::async` / `threading.Thread`) — documented in
`realtime_decoding.rst`.

## Testing

- 7 new C++ unit tests (`DecoderCudaDeviceId.*`): kwarg contract
(absent/negative/out-of-range), key stripped before strict-validating
plugin ctors, persistent pin observable after construction, **two
decoders on two GPUs from two threads**, async worker pinning itself
(verified RED→GREEN on a 2-GPU machine). GPU tests skip below the needed
device count.
- YAML: round-trip with the new field; `prepare_decoder_params` surfaces
the knob for trt and non-trt types (ordering vs the trt-only early
return is locked by test).
- Python: kwargs error path (`cuda_device_id` named in the error) and
valid-id construct+decode. Full `test_decoder.py` 61/61.
- Full suites: `test_decoders` 52/52, `test_decoders_yaml` 20 pass / 2
skips (nv-qldpc-gated).

## Notes for reviewers

- Known pre-existing quirk (not introduced here): negative int kwargs
from Python surface as an opaque `bad_cast` because `hetMapFromKwargs`
stores Python ints as `size_t` (`libs/core` `kwargs_utils.h`) — the
friendly negative-id message is only reachable from C++/YAML. Follow-up
candidate in core.
- `nv-qldpc-decoder` internal changes (mirroring the trt pattern) are a
separate follow-up.

Supersedes #663 (same content, reopened from the fork).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Signed-off-by: kvmto <kmato@nvidia.com>
Signed-off-by: Melody Ren <melodyr@nvidia.com>
Co-authored-by: kvmto <kmato@nvidia.com>
…fixes

Signed-off-by: Melody Ren <melodyr@nvidia.com>
Signed-off-by: Melody Ren <melodyr@nvidia.com>
@melody-ren

Copy link
Copy Markdown
Collaborator Author

/ok to test 8c266d3

@melody-ren
melody-ren marked this pull request as ready for review July 13, 2026 23:11

@bmhowe23 bmhowe23 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved given that #692 will follow soon thereafter

@melody-ren
melody-ren merged commit 9c5c230 into NVIDIA:main Jul 13, 2026
24 checks passed
@melody-ren
melody-ren deleted the melodyr/pin-device-fixes branch July 13, 2026 23:34
bmhowe23 added a commit to bmhowe23/cudaqx that referenced this pull request Jul 14, 2026
Bring in merged main, including the cuda_device_id GPU-pinning knob (NVIDIA#690)
and its follow-up fixes (NVIDIA#678). NVIDIA#690's cuda_device_id additions
(decoder_config field, YAML mapOptional, Python def_rw, the two YAML
tests, and the realtime_decoding.rst example/prose) merge cleanly into
the schema-registry config on this branch and are absorbed here.

The docs conflict (this branch's decoder_custom_args schema section vs
main's cuda_device_id section) is resolved by keeping both.

Two branch-side adaptations NVIDIA#690 could not anticipate are layered on in
the following commit: exporting cuda_device_id in this branch's
decoder_config_json_schema(), and adapting NVIDIA#690's trt YAML test to the
removed trt_decoder_config struct.

Signed-off-by: Ben Howe <bhowe@nvidia.com>
melody-ren added a commit that referenced this pull request Jul 14, 2026
Remove `hololink_gpu_id` env var

Follow up to #678

---------

Signed-off-by: kvmto <kmato@nvidia.com>
Signed-off-by: Melody Ren <melodyr@nvidia.com>
Co-authored-by: kvmto <kmato@nvidia.com>
bmhowe23 added a commit to bmhowe23/cudaqx that referenced this pull request Jul 15, 2026
…ridge branch

Main landed the squashed PR 670 plus NVIDIA#656/NVIDIA#673/NVIDIA#674/NVIDIA#678/NVIDIA#680/NVIDIA#683/NVIDIA#688/
NVIDIA#690/NVIDIA#691/NVIDIA#692.  Resolution keeps this branch's design and ports main's
content into it:

- Naming: main's GpuRoce{Transceiver,Factory,LinkCheck} map 1:1 onto this
  branch's DeviceGraph* files (the de-transport-ing follow-up requested in
  the PR 670 review).  Main's post-review fixes are ported into the
  renamed files: ring-size overflow + host-page-size alignment validation,
  gpu_id resolved from the decoder's cuda_device_id instead of an env var,
  the factory taking pinned_cuda_device, and the linkcheck exercising the
  new factory signature.
- Schema: per-decoder 'dispatch: host|device_graph' plus the top-level
  transport section stay; main's per-decoder 'transport:' key does not
  return.  cuda_device_id is adopted as a per-decoder placement knob
  (config struct + YAML trait), and the hsb script now injects
  'dispatch: device_graph' + cuda_device_id and drives the server with
  QEC_DEVICE_GRAPH_* env and the device_graph READY sentinel.
- Features adopted from main: decoder CUDA-device pinning (worker-thread
  pin via promise, graph-capture pin, hardware_guards.h), per-session
  decode counters + print_session_stats + QEC_DECODING_SERVER_STATS
  server-side stats printing, DecodingServer ctor exception safety,
  virtualized realtime decoder API (NVIDIA#674), CMP0126 fix, CUDA::cudart on
  the core lib, and the cudevice-archive dedup in the server link.
- DecodingSession combines main's set_graph_capture_device with this
  branch's reserved-SMs decode-graph capture
  (QEC_DEVICE_GRAPH_RESERVED_SMS).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Signed-off-by: Ben Howe <bhowe@nvidia.com>
anjbur added a commit to anjbur/cudaqx that referenced this pull request Jul 16, 2026
This reverts commit 9c5c230.

Signed-off-by: Angela Burton <angelab@nvidia.com>
anjbur added a commit to anjbur/cudaqx that referenced this pull request Jul 16, 2026
…ntegration

Signed-off-by: Angela Burton <angelab@nvidia.com>
anjbur added a commit to anjbur/cudaqx that referenced this pull request Jul 16, 2026
…VIDIA#609)". Resolve NVIDIA#609 revert conflicts by restoring the legacy host-call and direct-decoding paths while retaining the GPU device-placement fixes from NVIDIA#690 and NVIDIA#678.

This reverts commit 927ec7f.

Signed-off-by: Angela Burton <angelab@nvidia.com>
melody-ren added a commit that referenced this pull request Jul 17, 2026
…698)

## Background
- #690 introduced the cuda_device_id placement knob for GPU decoders.
- #678 made worker threads and the inproc graph capture honor the pinned
device, and pinned decoder construction.
- #683 closed the remaining gap: the gpu_roce decoding-server capture
path now pins too.

Each fix added a device pin to one more path via its own ad-hoc helper.
The "which device" decision ended up duplicated across dispatch,
capture, the worker, construction, and the gpu_roce transport. And that
is the motivation for this PR.

## What this PR does
Basically, every path should be following a single source of truth. 

Consolidate all of it to: the decoder's `cuda_device_id`, resolved one
way (`decode_device_for`) and applied through two sanctioned wrappers —
`pin_decode_device` (dispatch/decode) and `capture_graph_pinned` (graph
capture) — in `hardware_guards.h.` Every path now derives its device
from that one field; none selects a device by any other means. Unpinned
(< 0) keeps existing semantics: dispatch no-ops, capture defaults to
device 0.

Signed-off-by: Melody Ren <melodyr@nvidia.com>
cketcham2333 added a commit that referenced this pull request Jul 24, 2026
…r decoder, mixed host + device_graph dispatch (#682)

Built on the companion cuda-quantum PR
NVIDIA/cuda-quantum#4915, **now merged
upstream** (squash `2a7911f`, 2026-07-23); `.cudaq_version` pins that
commit, so this branch builds against stock `NVIDIA/cuda-quantum` main.

## Summary

This PR re-architects the realtime decoding server around the CUDA-Q
bridge-provider boundary. The server no longer contains any transport
code: the wire is named in the deployment YAML (or a `--transport`
fallback), loaded at runtime as a `libcudaq-realtime-bridge-<name>.so`
provider, and every decoder gets its own ring buffer and its own
consumer -- a host dispatcher thread for `dispatch: host` decoders, or
the GPU device-graph scheduler for `dispatch: device_graph` decoders,
both side by side in one server process. A partner transport library
drops in as a single `.so` with zero decoding-server changes.

The guiding litmus test for the layering: cudaq-realtime and its
transport providers never say "QEC" or "decoder"; the QEC library code
never names a wire (UDP, RoCE, hololink). Wire names appear only where
deployments are described: YAML configs, launch scripts, and tests.

## Before (main prior to #670; #670 landed the first step)

```
┌──────────────────────────────────────────────────────────────────────────┐
│                     decoding_server (pre-refactor)                       │
│  compiled-in wire branches, one per transport:                           │
│   #ifdef udp path      #ifdef cpu_roce path        gpu_roce fork         │
│   udp wrapper calls    RendezvousInfo + hsb_fpga   GpuRoceTransceiver =  │
│   wired directly       QP handshakes INLINE        hololink bring-up     │
│                        (byte-exact copy of the     FUSED with the QEC    │
│                        CpuRoceChannel structs)     dispatch engine       │
│  hand-rolled std::thread around cudaq_host_ring_dispatch_loop            │
│  ONE ring buffer + ONE dispatch loop shared by ALL decoders              │
│  two transport knobs that had to agree (--transport + per-decoder YAML)  │
└──────────────────────────────────────────────────────────────────────────┘
      │ link-time: udp/cpu_roce wrappers; DOCA + hololink + HSB + ibverbs
      ▼ adding a wire = editing this repo; no partner drop-in possible
```

- The server had per-transport code paths: udp and cpu_roce wired
directly against transport wrapper headers, and a separate gpu_roce fork
that linked hololink/DOCA/HSB/ibverbs into the QEC libraries
(`DT_NEEDED` on the server binary). Adding a wire meant editing the
server.
- Transport selection was two knobs that had to agree (`--transport` on
the CLI AND a per-decoder YAML key), with silent misconfiguration when
they disagreed.
- One ring buffer served all decoders: every RPC funneled through a
single dispatcher, and per-decoder endpoints (the topology the product
needs: caller routes with `device_id == decoder_id`) were impossible.
- The GPU device-graph path (`gpu_roce`) was hololink-only, named after
one wire, and could not coexist with host-dispatch decoders in the same
process.
- The CPU-RoCE rendezvous / HSB-FPGA QP handshake lived in the server
itself instead of behind the transport boundary.
- #670 (now on main) took the first step -- the gpu_roce engine moved
out of the core library behind a weak factory -- but the component still
links hololink/DOCA/HSB directly, serves exactly one decoder, is named
for one wire, and the per-decoder `transport:` key remains the selection
knob.

## After

```
┌──────────────────────────────────────────────────────────────────────────┐
│                    decoding_server (transport-blind)                     │
│  YAML `dispatch:` picks the ENGINE     YAML `transport:` picks the WIRE  │
│   (per decoder)                        (per deployment; --transport is   │
│                                         a fallback, conflict = error)    │
│  ONE RING PER DECODER, each with its own consumer:                       │
│   host ─► dispatcher object over        <name>  ► libcudaq-realtime-     │
│           its provider ring (4869 API)            bridge-<name>.so       │
│   device_graph ─► DeviceGraphRing-      /path.so ► partner library,      │
│           Consumer (GPU scheduler)                verbatim, zero changes │
│  geometry + READY ring tokens derived FROM the providers (v2 queries)    │
└──────────────────────────────────────────────────────────────────────────┘
     │ links                            │ links (weak factory, WHOLE_ARCHIVE)
┌────────────────────┐   ┌────────────────────────────────────────────────┐
│ CQR plugin         │   │ DecodingServer core · device-graph component:  │
│ (HOST_CALL table)  │   │ DeviceGraphTransceiver = dispatch ENGINE only  │
└────────────────────┘   └────────────────────────────────────────────────┘
     │ links (the ONLY realtime link dependency)
┌──────────────────────────────────────────────────────────────────────────┐
│  libcudaq-realtime.so — bridge loader (iface v2) + dispatcher object     │
└──────────────────────────────────────────────────────────────────────────┘
     ◌ dlopen ─────────────── runtime plug-in seam ────────────── ◌ dlopen
┌────────────┬──────────────────┬─────────────────┬────────────────────────┐
│ bridge-udp │ bridge-cpu-roce  │ bridge-hololink │ partner transport .so  │
│ .so        │ .so (rendezvous  │ .so (built on   │ (out of tree, ~9 C     │
│            │ + hsb_fpga)      │ the HSB rig)    │ functions)             │
└────────────┴──────────────────┴─────────────────┴────────────────────────┘
```

- **Bridge-provider-only server.** `decoding_server` speaks only YAML +
the `cudaq_bridge_*` C API. Provider libraries resolve by name next to
the cudaq-realtime install (`QEC_BRIDGE_PROVIDER_DIR`) or verbatim by
path (partner drop-in). The QEC libraries link no transport libraries;
the rendezvous/hsb_fpga handshake moved down into the cpu_roce provider
(companion cuda-quantum PR).
- **Engine vs. wire, each named once.** Per-decoder YAML `dispatch:
host|device_graph` picks HOW RPCs execute; the top-level, shape-keyed
`transport:` section (`provider`, `args`, plus a `device_graph:`
override for the rings that must be GPU-pollable) picks the wire for the
whole deployment. `--transport` is a fallback for configs that
intentionally leave the wire unspecified (one YAML reused across wires,
selected per launch); a YAML that names a provider combined with an
explicit `--transport` is a startup error, never a silent precedence
decision. All pre-release aliases (`transport:` as a per-decoder key,
`--transport=gpu_roce`, `HOLOLINK_*` env fallbacks) are removed -- this
component is new this cycle, so there is no compatibility surface to
keep.
- **One ring per decoder.** The server opens one bridge instance + one
ring + one consumer per YAML decoder; ring geometry and endpoint
identity come from the provider's v2 queries instead of re-parsed CLI.
Readiness publishes every endpoint in one line
(`QEC_DECODING_SERVER_READY port=<p0> ... ring<id>=<port>`) before any
blocking connect, and shutdown reports per-ring traffic
(`QEC_DECODING_SERVER_RING decoder=<id> dispatched=<n>`). Callers route
with `cudaq::device_call(decoder_id, ...)` and per-device endpoint args
(`udp-port.<id>=<port>`).
- **Mixed dispatch in one process.** `DeviceGraphRingConsumer` runs the
CUDA-Q device-graph scheduler (self-relaunching GPU dispatch graph + the
decoder's captured decode graph) as a ring consumer over any
GPU-pollable ring -- hololink DOCA rings on a rig, or pinned+mapped udp
rings (`--pinned-rings`) on any CUDA box. `GpuRoceTransceiver` was
renamed to what it actually is (`DeviceGraphTransceiver`, the dispatch
engine, transport-blind) and now delegates to the ring consumer; the
standalone all-device_graph path remains for the HSB flow.
- **Device-graph wedge root-caused and fixed.** The scheduler deadlock
after the first decode trigger was cooperative-launch co-residency
starvation: the decode graph was captured sized for every SM and could
never become co-resident with the persistent dispatch graph, so the
device-side fire queued forever at `grid.sync()`. `DecodingSession` now
captures with `reserved_sms=1` (`QEC_DEVICE_GRAPH_RESERVED_SMS` to raise
it on rigs where hololink RX/TX kernels are also resident). The same bug
class affects host-path GPU-cooperative decodes when a scheduler is
resident -- documented, with the mixed-deployment guidance of a CPU
decoder on host rings until the plugin plumbs reservation into its host
path.
- **Works with the session stats from main.**
`QEC_DECODING_SERVER_STATS=1` prints per-decoder counters in the mixed
server too; they are host-session counters, so a `device_graph` ring
legitimately reports `decodes=0` -- its execution evidence is the
trigger diagnostics (`fires == tail_relaunches`) and the per-ring
`dispatched=` line.
- **Tests and config schema.** New coverage: transport-section
parse/round-trip with a mixed host+device_graph decoder set, a
two-process decode where the YAML alone names the wire, CLI/YAML
conflict rejection, a per-decoder-rings two-process test asserting
traffic on each ring, and
`app_examples.surface_code-4-yaml-mixed-dispatch` -- the flagship mixed
flow as a gated ctest (registered only when the server links the
device-graph component; skips without a GPU or the nv-qldpc plugin)
asserting scheduler health via the new trigger diagnostics (rc=0, fires
== tail_relaunches > 0). The generated JSON config schema
(`decoder_config_json_schema()`) advertises the new per-decoder
`dispatch:` key and the top-level `transport:` section (the removed
per-decoder `transport:` key is gone from the schema too), with a python
`jsonschema` test that validates a populated `dispatch`/`transport`
document against it and rejects the removed key. The python config
bindings expose the new fields as well -- `decoder_config.dispatch`,
`multi_decoder_config.transport`, and the `decoder_dispatch` /
`transport_config` / `transport_shape_override` types.

## Sample configurations

Three representative deployment shapes (YAML config + exact launch line
+ matching caller config):

**Two host decoders, one udp ring per decoder** -- the YAML says nothing
about the wire, so `--transport` (default udp) selects it per launch;
the READY line publishes every ring's endpoint.

```yaml
decoders:
  - id: 0
    type: pymatching
    # block_size / syndrome_size / H_sparse / ...
  - id: 1
    type: pymatching
    # ...
```

```
decoding_server --config=decoders.yaml
# QEC_DECODING_SERVER_READY port=<P0> transport=udp ring0=<P0> ring1=<P1>
```

Caller routes per decoder with device-scoped endpoint args:
`--cudaq-device-call=udp udp-host=127.0.0.1 udp-port=<P0>
udp-port.1=<P1>`.

**Mixed dispatch (host CPU decoder + GPU device-graph decoder), runs on
any CUDA box** -- the wire lives in the YAML transport section; the
shape-keyed override adds `--pinned-rings` only to the device_graph ring
so the GPU scheduler can poll it. No `--transport` on the command line
(combining both is a startup error). This is exactly what the new gated
ctest runs.

```yaml
transport:
  provider: udp
  device_graph:
    args: [--pinned-rings]
decoders:
  - id: 0
    type: multi_error_lut
    # ...
  - id: 1
    type: nv-qldpc-decoder
    dispatch: device_graph
    # ...
```

```
decoding_server --config=decoders.yaml
```

**Partner transport drop-in** -- an out-of-tree provider library is
named by path, verbatim; its args are forwarded untouched. Zero
decoding-server changes.

```yaml
transport:
  provider: /opt/partner/libpartner_bridge.so
  args: [--lane=3]
decoders:
  - id: 0
    type: pymatching
    # ...
```

```
decoding_server --config=decoders.yaml
```

## Validation

- Two-process suite 6/6 (udp; includes per-decoder rings and the
YAML-transport-section tests), decoding-server core + YAML suites,
per-decoder-rings app example.
- Re-validated after merging main with #670 landed
(#656/#673/#674/#678/#680/#683/#690/#691/#692): two-process suite,
DecoderYAMLTest 18/18, per-decoder-rings + mixed-dispatch app tests,
python surface_code-1, and the full mixed E2E all green against an
nv-qldpc plugin rebuilt for #674's virtualized decoder API (an ABI break
for out-of-tree plugin builds).
- Full mixed E2E on a WSL2 laptop, two-process, wire named only by the
YAML: multi_error_lut on a host ring + nv-qldpc RelayBP behind the GPU
device-graph scheduler on a pinned-udp ring -- decode graph fired for
every window (trigger rc=0, fires == tail_relaunches), correct
corrections, both rings dispatched, clean teardown. The HSB rig is no
longer required to exercise the device-graph dispatch path; rig runs
remain the validation for the hololink and cpu_roce RDMA data planes.

## Breaking changes vs. main

All of these surfaces are new this release cycle, so no deprecation
aliases are kept:

- The per-decoder `transport:` YAML key and the `DecoderTransport` enum
are replaced by per-decoder `dispatch: host|device_graph` plus the
top-level `transport:` section. A config using the old key fails to
parse loudly. `cuda_device_id` (#690) is kept unchanged and now also
places the device_graph rings and scheduler.
- The device-graph transceiver's environment surface is
`QEC_DEVICE_GRAPH_*` (was `HOLOLINK_*`), and `--transport=gpu_roce` no
longer exists: device_graph is a dispatch shape named in the YAML;
`--transport` only ever names a wire provider. The HSB test script is
updated to match (injects `dispatch: device_graph` + `cuda_device_id`,
sets `QEC_DEVICE_GRAPH_*`, waits for `READY device_graph`).
- `CpuRoceTransceiver` (the always-throwing placeholder) is removed;
cpu_roce is served by its bridge provider.

## Dependencies

- **Built on the companion cuda-quantum PR
[#4915](NVIDIA/cuda-quantum#4915 ([realtime]
pluggable transport providers / bridge interface v2 + per-device
device_call sessions), **merged upstream 2026-07-23** (squash `2a7911f`)
and itself built on cuda-quantum #4869. `.cudaq_version` pins that
squash commit, so this branch builds against stock main. This PR
consumes `cudaq_bridge_create_from_library`, the v2 endpoint/geometry
queries, per-device sessions and device-scoped channel args, the udp
provider's `--pinned-rings`, and `cudaq_dispatch_get_trigger_debug`.
- **Built on main with #670 landed** (origin/main is merged into this
branch). Relative to landed #670, this PR completes the follow-up its
review called for -- removing the server's transport awareness:
`GpuRoce{Transceiver,Factory,LinkCheck}` become `DeviceGraph*` (same
weak-factory / optional-component structure, now transport-blind), while
#670's post-review hardening (ring-size and host-page-alignment
validation, `cuda_device_id`-driven GPU placement threaded through the
factory) is preserved in the renamed files.
- The nv-qldpc decoder plugin and the proprietary cudevice archive are
consumed as prebuilt binaries
(`CUDAQ_QEC_REALTIME_CUDEVICE_PROPRIETARY_ARCHIVE`); builds without them
still compile and the device-graph paths fail at runtime with a clear
not-linked error, and the gated ctest is simply not registered.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Signed-off-by: Ben Howe <bhowe@nvidia.com>
Signed-off-by: Chuck Ketcham <cketcham@nvidia.com>
Co-authored-by: Chuck Ketcham <cketcham@nvidia.com>
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants