Skip to content

[None][feat] cache transceiver nixl bounce buffer - #15780

Open
chuangz0 wants to merge 30 commits into
NVIDIA:mainfrom
chuangz0:worktree-bounce-v2
Open

[None][feat] cache transceiver nixl bounce buffer#15780
chuangz0 wants to merge 30 commits into
NVIDIA:mainfrom
chuangz0:worktree-bounce-v2

Conversation

@chuangz0

@chuangz0 chuangz0 commented Jun 30, 2026

Copy link
Copy Markdown
Collaborator

Dev Engineer Review

  • Adds NIXL bounce-buffer v2 for disaggregated KV-cache transfers.
  • Adds arena allocation, transfer planning, credit scheduling, CUDA gather/scatter, wire codecs, control channels, and NIXL transport integration.
  • Adds capability handshakes, timeout handling, cancellation, peer recovery, and shutdown cleanup.
  • Routes eligible transfers through Bounce v2 and falls back to standard NIXL when initialization fails.
  • Extends AgentDesc serialization with bounce handshake metadata.
  • Adds Python and C++ observability for bounce activation and submission counts.
  • Review focus includes API consistency, CUDA resource ownership, thread safety, RDMA completion handling, shutdown ordering, fallback behavior, and configuration validation.
  • CI failures require follow-up before merge.

QA Engineer Review

  • Adds unit, CUDA, ZMQ, NIXL transport, RDMA, failure-recovery, production-agent, and Python integration tests.
  • Covers arenas, configuration parsing, message codecs, transfer planning, allocation, scheduling, execution pools, gather/scatter, control channels, transport recovery, fairness, backpressure, handshakes, and data integrity.
  • Adds production-path tests for one-way, bidirectional, concurrent, and multi-sender transfers.
  • Adds test_python_nixl_cache_transceiver_uses_cpp_bounce.
  • Registers the Python test in tests/integration/test_lists/test-db/l0_h100.yml.
  • Coverage mapping for the C++ tests is not provided.
  • Verdict: needs follow-up.

Description

NIXL Bounce-Buffer v2 — Design

Describes the current (as-built) implementation. Code lives in
cpp/tensorrt_llm/executor/cache_transmission/nixl_utils/bounce/, integrated through
NixlTransferAgent (transferAgent.cpp) and gated at runtime by TRTLLM_NIXL_BOUNCE_ENABLE.

1. Motivation

A single disaggregated-KV submitTransferRequests often carries thousands to tens of thousands of
small (~4 KiB) scattered descriptors
. Submitting them to NIXL/NIC one-by-one is dominated by
per-descriptor overhead, leaving the link far below line rate.

The data-path idea: the sender gathers the scattered small descriptors into one pre-registered
buffer → does a single RDMA write to a peer buffer → the receiver scatters back to the final
destinations:

src×N  ──gather──▶  region(sender)  ──RDMA write──▶  region(receiver)  ──scatter──▶  dst×N

The hard part is the control plane: how buffers are allocated across senders, flow-controlled,
recycled, and how errors are handled. Requirements:

  • R1 Stream gracefully even when a single request exceeds the total buffer on both sides
    (bounded buffers carry an unbounded transfer).
  • R2 Pipeline gather / RDMA write / scatter across GPU and NIC to saturate the NIC.
  • R3 One receiver written concurrently by many senders: fair, starvation-free, no cross-talk.
  • R4 Thread-safe under multi-threaded submit.
  • R5 Any error / peer loss / teardown resolves wait() (SUCCESS/FAILURE) — never hangs.
  • R6/R7 Modular, testable, readable; control and data planes are pluggable.
  • R8 Pack many small concurrent requests (per-request bytes < buffer size) tightly into the shared
    buffer — no request reserves a whole buffer, which would waste memory and cap concurrency.

R1 and R8 pull in opposite directions — carry one over-sized request and pack many small ones into
the same fixed buffer — and together motivate the variable-size region arena (§2).

2. Overview

  • One shared BounceArena (a device buffer registered once) is sliced into variable-size
    regions
    : each chunk gets a region of exactly its byte size. Many small requests pack tightly
    (high concurrency, no waste); a request larger than the arena streams chunk-by-chunk with recycling.
  • Credit flow control: the receiver owns the buffer; a sender must obtain a credit
    (exclusive write permission to a region) before writing. Credits are granted incrementally per chunk
    (WANT/GRANT) and recycled on scatter completion (ACK) — bounded end to end.
  • Eager gather (default on): submit() launches a chunk's gather before the GRANT arrives,
    overlapping the WANT→GRANT control round-trip with the gather kernel. Eager (credit-less) staging is
    capped at half the arena, so on a bidirectional deployment both sides can always still grant
    incoming regions (no mutual eager-starvation); credit-backed allocations are not capped.
  • Pluggable control channel: ZMQ/TCP by default; optionally the control messages ride NIXL
    notifications
    (UCX active messages on the RDMA fabric, TRTLLM_NIXL_BOUNCE_USE_NIXL_NOTIFICATIONS),
    dropping a control hop from tens of microseconds to a few. Peers must use the same control kind —
    enforced by the capability handshake (§5).
  • Single-IO-thread reactor: one IO thread per agent owns the credit / request state (nearly
    lock-free), plus M scatter workers.
  • No notifMsg, no extra flush on the data plane: data-landed is decided purely by the sender
    polling poll==SUCCESS (the NIXL UCX backend already appends ucp_ep_flush_nbx per transfer, so
    SUCCESS ⇒ the data is visible at the remote target).
  • Decoupled execution resources: the stream/event/scratch needed to run one gather/scatter kernel
    comes from a small ExecPool (copyStreamCount contexts), borrowed/returned per kernel — separate
    from a region's long lifetime (which lasts until ACK).
flowchart LR
    subgraph SND["Sender agent (IO thread)"]
      REQ["Request{ numChunks,<br/>nextPost, acked }"]
      OUT["shared BounceArena + ExecPool<br/>acquireLocal(bytes) → gather staging<br/>(eager: before GRANT, ≤ ½ arena)"]
    end
    subgraph RCV["Receiver agent (IO thread)"]
      SCH["CreditScheduler (single allocator)<br/>BuddyAllocator(arena)<br/>flows{ pending, held } + localHeld<br/>round-robin ring + drain mode"]
      IN["shared BounceArena<br/>variable-size regions (RDMA targets)"]
      SW["scatter workers ×M (borrow ExecPool)"]
    end
    REQ -- "① WANT(rid, chunk_bytes[])" --> SCH
    SCH -- "② GRANT(regionHandle, addr, len)" --> REQ
    REQ -- "③ gather→RDMA write→DATA(regionHandle, scatter runs)" --> IN
    IN --> SW
    SW -- "④ scatter_done" --> SCH
    SCH -- "⑤ ACK(regionHandle)" --> REQ
    SCH -. "owns/allocates arena regions" .-> IN
    REQ -. "③ occupy / ⑤ release" .-> OUT
Loading

One agent can be both sender and receiver, and both roles share the same arena (most disagg agents
only send or only receive, so one buffer halves memory; a dual-role agent still shares a single arena,
deadlock-free — the eager cap above is what makes the bidirectional case safe).

3. Terminology

Term Meaning
region A variable-size slice of BounceArena; its handle = byte offset within the arena (addr = baseAddr + offset).
chunk A unit produced by BounceTransferPlan by bin-packing scattered (src,dst) descriptors; ≤ maxChunkSizeBytes, moved by one RDMA write.
credit Exclusive write permission to a region, handed to exactly one sender as GRANT{regionHandle, addr, len}.
flow One independent request stream, key = "peer\x1f rid" (concurrent requests from the same peer are distinct flows).
in-flight cap W Per-flow cap on in-flight regions (= pipeline depth) — maxInflightChunksPerRequest.
arena The single shared, registered-once device buffer (BounceArena).
ExecCtx {stream, event, scratch, hostPinned} needed to run one gather/scatter, borrowed/returned from ExecPool.
gather / scatter Batched D2D copy between many small descriptors and a contiguous region (GatherScatterKernel).
scatter run A coalesced DATA plan entry (BounceScatterRun): adjacent descriptors merged when contiguous or uniformly strided.
handshake Per-agent bounce capability blob in AgentDesc (§5); peers engage bounce only when compatible.

4. Modules

Pure logic (no GPU / threads / IO — unit-testable):

Module Responsibility
BounceConfig env → POD config snapshot (fromEnv); byte-valued vars accept binary K/M/G suffixes ("256MB", "1gb", "512KiB"); garbage values fall back to defaults instead of parsing to 0.
BounceTransferPlan Bin-pack (src,dst) descriptors → chunks (each ≤ maxChunkSizeBytes, 32 B aligned, zero-length skipped); compute each descriptor's in-region offset and packedBytes; coalesce the scatter view into scatterRuns (contiguous or uniform-stride merge) so the DATA message shrinks from per-desc entries (hundreds of KB) to a handful of runs.
BounceMessage Control-plane wire codec (fixed header + fixed-size entries); little-endian; includes the handshake codec (encodeHandshake/decodeHandshake) and the cancel codec (encodeCancel/isCancelWant).
BuddyAllocator Pure power-of-two buddy allocator over byte offsets; alloc(bytes)/free(offset), coalesces buddies, no external fragmentation, internal ≤ 2×.
CreditScheduler Receiver-side credit allocation + round-robin fairness + drain-mode anti-starvation (§5); embeds a BuddyAllocator over the arena; also serves local-sender acquireLocal(bytes) with the eager half-arena cap. Owned by the IO thread; the only cross-thread caller is acquireLocal() from submit() app threads (eager gather staging).

Device / IO / integration:

Module Responsibility
BounceArena An arenaSizeBytes device buffer (MNNVL via common::FabricMemory, else cudaMalloc), registered once; base()/baseAddr()/at(offset).
ExecPool copyStreamCount ExecCtxs; tryAcquire() (non-blocking, nullptr when full) / release(), thread-safe.
GatherScatterKernel Batched memcpy. Default: custom kernel (uint4-vectorized; byte path for misaligned) reading its `[srcs
TransferEngine (abstract) The only data-plane ops: registerRegion / postWrite / poll / release. NixlTransferEngine (production, wraps one nixlAgent) is the sole implementation; transport tests run over real NIXL loopback.
ControlChannel (abstract) addPeer (returns success) / removePeer / sendTo / recv / localEndpoint. Two implementations: ZmqControlChannel (default): a ROUTER for receive + one DEALER per peer for send; sendTo is non-blocking (drops on full kSendHwm, never blocks the IO thread). NixlNotifControlChannel: control messages as NIXL notifications on the RDMA fabric (no TCP sockets; "endpoint" is serialized NIXL metadata).
BounceTransport Thin reactor: 1 IO thread + M scatter workers; holds BounceContext + BounceSender + BounceReceiver, routes control messages to the right role, drains both roles each tick; submit() / addPeer() / forgetPeer() / shutdown(); owns the capability handshake (localHandshakeBlob / registerPeerHandshake / hasPeerHandshake).
BounceContext Dependencies shared by both roles and owned by the single IO thread: injected channel/engine/arena/exec, the single CreditScheduler (one arena serves both directions), sendGrants().
BounceSender [S] role: submit→WANT (+ eager gather), GRANT→attach credits / gather+write, ACK→resolve; holds the request table + send-side deferred-cleanup state (mOrphanLocal / mPendingCancel).
BounceReceiver [R] role: WANT→grant region, DATA→scatter, reply ACK; holds scatter workers + job/done queues + mScattering (orphaned flag for in-flight scatters).
BounceNvtx NVTX ranges over the transfer pipeline (submit / gather / write / scatter / control hops) for nsys analysis.
NixlTransferAgent integration maybeInitBounce (build arena+exec+transport, register arena; any init failure warns and falls back to the standard NIXL path — never fails agent construction), shouldUseBounce (routing decision, gated on the peer handshake), AgentDesc carries the local handshake blob, invalidateRemoteAgentforgetPeer. Built only when NIXL + zmq are available (TLLM_BOUNCE_V2); decoupled from ENABLE_UCX.

5. Control Plane: Credit Flow Control + Fair Scheduling (R1/R3)

Messages (all over ControlChannel — zmq by default, NIXL notifications opt-in):

Message Direction Payload
WANT sender → receiver per-chunk byte sizes (empty = cancel) + the sender's own control endpoint.
GRANT receiver → sender credits {addr, len, devId(receiver), regionHandle}.
DATA sender → receiver regionHandle + coalesced scatter runs; sent only after poll==SUCCESS (the scatter trigger).
ACK receiver → sender regionHandle; scatter done, region recyclable.

Capability handshake (bootstrap + compatibility, key). Each agent's AgentDesc carries a bounce
handshake blob: {wireVersion, controlKind (ZMQ | NIXL_NOTIF), arenaUsableCapacityBytes, maxChunkSizeBytes, endpoint}. loadRemoteAgentregisterPeerHandshake validates it — version,
control kind, and maxChunkSizeBytes must match the local config, and the peer's endpoint must be
registrable — and only then marks the peer bounce-capable. shouldUseBounce requires
hasPeerHandshake(peer), so a peer with bounce disabled, a different control transport, or mismatched
chunking silently stays on the standard NIXL path (no WANT ever stalls to requestTimeoutMs).
An agent that cannot produce a usable local endpoint advertises no handshake (never breaks
metadata exchange).

Reverse-path bootstrap. Bounce needs a two-way control channel (sender sends WANT/DATA, receiver
replies GRANT/ACK), but the disagg metadata exchange is one-directional — the KV sender
loadRemoteAgents the receiver, the receiver never loads the sender. So WANT also carries the
sender's control endpoint, and the receiver addPeer(sender)s in onWant to bootstrap the
reverse path. A malformed endpoint in a WANT is rejected on the reactor thread (warn, no grant, no
exception escapes); a cancel is still honored even when endpoint registration fails, so it can reclaim
flow state left by an earlier valid WANT. Cancel/abort uses an empty WANT (still carrying the
endpoint) — no separate handshake / RETURN message.

Endpoints are routable IPs (multi-node, ZMQ). ZmqControlChannel must not bind 127.0.0.1
(unreachable cross-node). maybeInitBounce resolves the local routable IP via the shared
common::getLocalIp(getEnvNixlInterface(), rank) (TRTLLM_NIXL_INTERFACE picks the NIC, else
auto-detect by egress route / hostname — identical to UCX/NIXL addressing) and binds tcp://<ip>:*;
localEndpoint() reads the actual tcp://<ip>:<port> from zmq last_endpoint and advertises it via
the handshake / WANT. Unit tests that construct ZmqControlChannel directly keep the
tcp://127.0.0.1:* default. IPv6: zmq disables IPv6 by default, so an IPv6 bind address is
bracketed (tcp://[<ip>]:*) and the ROUTER sets ZMQ_IPV6; the DEALER (addPeer) sets ZMQ_IPV6
unconditionally (harmless for IPv4) — aligned with ucx_utils. The ROUTER additionally sets
ZMQ_ROUTER_HANDOVER so a peer that is forgotten (removePeer drops its DEALER) and later reconnects
with the same routing id is accepted, rather than having its messages silently dropped while the stale
connection is reaped. addPeer validates the endpoint before connecting and reports failure to the
caller. With NixlNotifControlChannel the "endpoint" is serialized NIXL metadata; no TCP is involved.

Receiver state (lives on the IO thread, lock-free): BuddyAllocator arena +
flows{ pending: per-chunk bytes, held: region offsets, blockedAtGrantSequence } + a round-robin
ring of active flow keys + a cursor + a grant sequence counter. Fixed per-flow cap
W = maxInflightChunksPerRequest.

schedule() — on-demand, round-robin fair, never poisons the queue, never deadlocks:

flowchart TD
    Start([event triggers schedule:<br/>onWant / onScatterDone / reclaimFlow / reclaimByPrefix / releaseLocal]) --> D0{drain mode active?<br/>a flow bypassed ≥2 full rounds}
    D0 -- yes --> DAlloc{"arena.alloc(drain flow's head)<br/>fits?"}
    DAlloc -- no --> Hold([no NEW remote grants until it fits<br/>existing regions keep freeing])
    DAlloc -- yes --> DGrant[grant it, exit drain mode] --> C1
    D0 -- no --> C1{ring non-empty?}
    C1 -- no --> Done([return accumulated GRANTs])
    C1 -- yes --> Sweep[one round-robin sweep from the cursor]
    Sweep --> Find{current flow:<br/>pending non-empty AND held.size &lt; W?}
    Find -- "none in the whole sweep" --> Done
    Find -- yes --> Alloc{"arena.alloc(pending.front())<br/>fits?"}
    Alloc -- no --> Mark[mark flow blocked at current grant sequence] --> Sweep
    Alloc -- yes --> Grant["off = the allocation<br/>pending.pop_front(), held += off<br/>accumulate GRANT{off, base+off, len}<br/>advance cursor past this flow"]
    Grant --> C1
Loading

Intuition. schedule() answers: many remote senders want to write into the same shared arena
how to hand out arena space fairly and bounded. Three constraints:

  1. Fair: flows take turns (round-robin); no early flow monopolizes.
  2. Per-flow rate limit (W): a flow may hold at most W in-flight regions (held.size() < W);
    more must wait for an ACK to free one — this is the pipeline depth.
  3. Aggregate rate limit (arena): all flows' in-flight regions share one arena; if the next chunk
    doesn't fit, skip it for now (backpressure, not an error).

Think of it as taking turns at a ticket counter: ring is the queue of flows, cursor is "who's
next". Each inner sweep hands out exactly one region — to the flow that is next, still wants more
(pending non-empty), is under its cap (held < W), and whose front chunk fits right now — then
advances cursor past it and starts a fresh sweep. So grants alternate across flows rather
than filling one flow's window first. The outer loop repeats until a whole sweep grants nothing
(all pending-empty / at-cap / can't-fit).

Example (W=2, arena currently fits 4 regions; flow A has 3 chunks c1/c2/c3, flow B has 2 chunks
d1/d2, cursor starts at A):

Step cursor Action A.held B.held
1 A grant A/c1 1 0
2 B grant B/d1 1 1
3 A grant A/c2 2 1
4 B grant B/d2 2 2
5 A A at cap (2≥W), B at cap → no progress → stop 2 2

Grant order A,B,A,B (strict alternation); A's c3 stays in pending until one of A's regions is
ACKed (onScatterDoneschedule()) and the next schedule() grants it. Each schedule() returns
the new batch of GRANTs, which sendGrants splits by flow key and sends to the right peer.

Notes:

  • Two-level rate limiting: per-flow W bounds a single flow's pipeline depth; arena capacity
    bounds aggregate concurrency (alloc failure ⇒ backpressure, not deadlock). There is no "divide cap
    by active flow count" logic.
  • Large-chunk anti-starvation (drain mode): a flow whose head chunk fails to fit is stamped with
    the current grant sequence. When other grants have bypassed it for ≥2 full rounds
    (kBypassRounds), the receiver enters drain mode for the oldest such flow: no new remote grants
    are issued until that head chunk fits (existing regions keep progressing and freeing space).
    acquireLocal() is deliberately unaffected — this is a receiver-only admission barrier and cannot
    introduce a bidirectional circular wait. Config guarantees maxChunkSizeBytes ≤ arena usable capacity (clamped at init), so a drained arena can always fit any chunk.
  • Flow lifecycle reclaim: the flow key contains a monotonic non-reused rid; when both pending
    and held are empty, eraseIfDone drops the flow immediately — otherwise flows/ring grow
    unbounded on a long-running server and schedule() degrades to O(historical requests).
  • Local sender shares the arena: acquireLocal(bytes) takes a gather-staging region from the same
    BuddyAllocator; eager (credit-less) staging is capped at half the arena (§2); the conservation
    invariant holds across {free bytes, each flow's held, localHeld}.

6. Data Plane & Pipeline (R2)

  • The receiver fills a flow's held up to W (when space allows, one GRANT message batches multiple
    credits) → the sender holds W credits at once → W chunks in flight; each ACK frees a region and
    the receiver refills to keep held = W.
  • Eager gather hides the control RTT: with enableEagerGather (default), submit() immediately
    stages and launches gathers for the first chunks (up to the in-flight cap and the eager half-arena
    budget) before any GRANT arrives; attachCredits later binds arriving credits to
    already-gathered chunks in strict chunk order, promoting their staging regions out of the eager
    budget. The WANT→GRANT round-trip and the gather kernel overlap instead of serializing.
  • W is sized by the round-trip: W ≥ ⌈(write + getXferStatus + DATA + scatter + ACK/GRANT return) / single-chunk write⌉ (bandwidth-delay product); gather/scatter (D2D ~TB/s) hide in the shadow of the
    previous chunk's RDMA (IB ~25 GB/s), so the NIC stays the bottleneck.
  • Gather and scatter each borrow a separate ExecCtx stream, so different chunks' gather/write/scatter
    overlap in wall-clock.
  • Small control messages: the DATA scatter plan is run-merged — adjacent descriptors whose
    (bounceOffset, dstPtr) advance contiguously or by a uniform stride collapse into one
    BounceScatterRun (the fully-dense case, e.g. ctx tp1 → gen tp4, collapses thousands of descs to a
    handful of runs). TRTLLM_NIXL_BOUNCE_DISABLE_SCATTER_RUN_MERGING restores per-desc entries for
    control-plane A/B debugging only.
  • No notifMsg / no GPUDirect flush: getXferStatus==SUCCESS already includes NIXL's per-transfer
    ucp_ep_flush_nbx (complete at both origin and target). The sender sends DATA as soon as it polls
    SUCCESS; the receiver scatters on receipt.

Single-chunk timing across both planes (control = solid, data = dashed; eager gather runs ① before
②'s GRANT when enabled):

sequenceDiagram
    autonumber
    participant App as Sender app thread
    participant SIO as Sender IO thread
    participant NIC as Data plane RDMA/NIC
    participant RIO as Receiver IO thread
    participant SW as Receiver scatter worker
    App->>RIO: WANT(rid, chunk_bytes[])
    App-->>App: ① eager GATHER (D2D): N small src → arena.at(o) (launch + eventRecord, no sync)
    Note over RIO: schedule(): arena.alloc carves region s, held[flow]+=s
    RIO->>SIO: GRANT(rid, regionHandle=s, addr, len)
    Note over SIO: onGrant: attachCredits to the eager-gathered chunk (or gather now if not eager)
    Note over SIO: drainGatherReady: cudaEventQuery==success (gather done, no block)
    SIO-->>NIC: ② postWrite(arena.at(o) → addr) async RDMA, no notif, return ExecCtx on done
    NIC-->>RIO: data written into receiver region s
    Note over SIO: pollSenderHandles: poll==SUCCESS (incl. ucp_ep_flush_nbx ⇒ landed at remote target)
    SIO->>RIO: ③ DATA(rid, chunk, regionHandle=s, scatter runs)
    Note over RIO: onData: validate runs against the flow's region, enqueue ScatterJob(s, runs)
    RIO->>SW: ScatterJob(s)
    SW-->>SW: ④ SCATTER (D2D): arena.at(s) → final dst×N (borrow ExecCtx, launch + streamSync)
    SW->>RIO: scatter_done(s)
    Note over RIO: onScatterDone: arena.free(s), schedule() may GRANT the next chunk
    RIO->>SIO: ⑤ ACK(rid, chunk, regionHandle=s)
    Note over SIO: onAck: releaseLocal(region o), acked++, all ACKed ⇒ promise=SUCCESS
    SIO->>App: future ready (SUCCESS)
Loading

For a large request (K > in-flight cap / arena capacity), the loop above repeats with both sides'
memory staying at O(W) regions while the transfer size is unbounded (R1).

7. Threading (R4/R5)

  • One IO thread per agent, the sole owner of the CreditScheduler + sender request table (the key
    to being lock-free; the one cross-thread entry is eager acquireLocal from submit()). Each tick:
    1. recv one control message and dispatch;
    2. drainGatherReady (gather event ready → postWrite + return ExecCtx);
    3. pollSenderHandles (poll==SUCCESS → send DATA);
    4. drainScatterDone (worker report → send ACK + free region + reschedule);
    5. drainForgets / drainPendingPosts (retry parked credits) / checkTimeouts.
  • M scatter workers: take a ScatterJob → borrow ExecCtx → scatter kernel + sync → report to the IO
    thread.
  • submit() never blocks: registers a Request + sends WANT (+ launches eager gathers,
    fire-and-forget), returns a shared_future; safe to call from multiple threads.
  • Adaptive poll: when gather/scatter is in flight, recv uses a 0 ms timeout (low latency); fully
    idle uses 1 ms; after long 0 ms spinning it backs off ~50 µs so a long model-kernel gather delay
    can't busy-spin a core.

8. State Machines

Unified region lifecycle (one arena serves both roles; a region is held by exactly one kind of
owner at any time — the conservation invariant):

stateDiagram-v2
    [*] --> FREE: arena init
    FREE --> INCOMING_HELD: GRANT(region→remote flow) 【schedule()】
    FREE --> OUTGOING_HELD: acquireLocal(bytes) 【local gather staging — eager ≤ ½ arena】
    INCOMING_HELD --> QUEUED: DATA(regionHandle, runs) received
    QUEUED --> SCATTERING: scatter worker picks it up (borrow ExecPool ctx)
    SCATTERING --> FREE: scatter_done → onScatterDone (reply ACK + reschedule)
    INCOMING_HELD --> FREE: forgetPeer / reclaimByPrefix (no in-flight DATA)
    OUTGOING_HELD --> FREE: ACK / failure → releaseLocal (reschedule — freed bytes go to a waiting flow)
    FREE --> [*]: shutdown
    note right of OUTGOING_HELD
      Invariant: every region is in exactly one of
      { free arena bytes } ∪ { some remote flow's held } ∪ { localHeld }.
      INCOMING_HELD = remote RDMA-write target (QUEUED/SCATTERING are its sub-states).
      OUTGOING_HELD = local gather source. Never held by both.
    end note
Loading

Sender chunk/request lifecycle (never hangs). With eager gather a chunk may reach Gathered
(gather event signalled, ExecCtx returned) while its GRANT is still in flight; attachCredits then
promotes it straight to the write:

stateDiagram-v2
    [*] --> WANT_SENT: submit() registers Request + sends WANT(chunk_bytes[]) + eager gathers
    WANT_SENT --> GATHERING: eager acquireLocal + launch gather (no credit yet)
    GATHERING --> GATHERED: drainGatherReady sees cudaEventQuery==success (waiting for credit)
    WANT_SENT --> POSTING: GRANT received (onGrant, credits queued)
    GATHERED --> IN_FLIGHT: attachCredits → postWrite
    POSTING --> POSTING: arena/exec full → credit parked, retried by drainPendingPosts (no block)
    POSTING --> GATHERING: borrow ExecCtx + acquireLocal(bytes) → launch gather + eventRecord (no sync)
    GATHERING --> IN_FLIGHT: gather done + credit attached → postWrite + return ExecCtx
    IN_FLIGHT --> DATA_SENT: pollSenderHandles sees poll==SUCCESS → send DATA
    DATA_SENT --> POSTING: ACK received and chunks remain (releaseLocal that region)
    DATA_SENT --> SUCCESS: acked == numChunks
    WANT_SENT --> FAILURE: checkTimeouts, no progress beyond requestTimeoutMs
    POSTING --> FAILURE: forgetPeer / shutdown
    GATHERING --> FAILURE: gather launch/record/stream error / forgetPeer / shutdown
    IN_FLIGHT --> FAILURE: poll==kFailed / forgetPeer / shutdown
    SUCCESS --> [*]: promise=SUCCESS
    FAILURE --> [*]: promise=FAILURE (empty WANT retracts credits)
    note right of WANT_SENT
      Every terminal state resolves the promise →
      the caller's wait() always returns, never hangs (R5)
    end note
Loading

9. Error Handling & Lifecycle (R5)

Every request reaches a terminal state; wait() never hangs. Bounce failures degrade, never break:
maybeInitBounce catches any construction error (fabric alloc, zmq bind, NIXL registration) with a
warning and leaves the agent on the standard per-desc NIXL path.

Case Trigger Handling
Peer incompatible (bounce off, other control kind, chunk-size mismatch, bad handshake) registerPeerHandshake at loadRemoteAgent Peer not marked bounce-capable → shouldUseBounce routes to standard NIXL (no WANT is ever sent, no timeout burned).
Peer never GRANTs (unreachable/not ready) checkTimeouts exceeds requestTimeoutMs Request → FAILURE (empty WANT retracts credits).
Malformed sender endpoint in WANT onWant addPeer fails/throws WANT rejected with a warning on the reactor thread (no grant); a cancel is still honored to reclaim earlier flow state.
Transfer engine error poll==kFailed Request → FAILURE, release in-flight handle.
gather launch/record error pumpRequest flags it → drainGatherReady Request → FAILURE (an unrecorded event would be misread as complete, so fail explicitly).
scatter kernel/sync error scatter worker No ACK → sender times out; never falsely reports landed (which would silently corrupt KV). Region is still freed (no leak).
Peer loss invalidateRemoteAgentforgetPeer forgetPeer drops the peer's DEALER + its handshake registration synchronously; the IO thread reclaimByPrefix("peer\x1f") reclaims all of the peer's flows + fails its in-flight requests. A fresh loadRemoteAgent must re-validate a new handshake.
Control message can't be sent (peer stalled, queue full kSendHwm) non-blocking sendTo returns EAGAIN Drop the message + WARNING; never block the IO thread. Affected request → FAILURE via requestTimeoutMs (no hang, no corruption).
shutdown join threads → cudaDeviceSynchronize → fail all in-flight requests.

Concurrency-safety points:

  • In-flight scatter vs. re-grant race: the receiver keeps a mScattering map (region offset → is
    orphaned) of all scattering regions. If forgetPeer reclaims a region still in mScattering (a
    worker is reading it), reclaimByPrefix defers the free (marks it orphaned) and only
    freeOrphanRegions it on scatter completion — preventing "new sender's RDMA write ⊥ worker's read".
  • Gather on the failure path: before reclaiming a region still GATHERING, cudaStreamSynchronize
    its stream (so an abandoned gather can't write a re-granted region); a sync error WARNs and clears the
    sticky error.
  • In-flight write on the failure path: a region in state Writing may still be read by the NIC as
    a source, so it cannot be freed immediately. It's recorded in mOrphanLocal;
    drainOrphanLocal() polls its xfer to a terminal state before release + releaseLocal (the
    send-side orphan mechanism, symmetric to the receive-side mScattering orphaned flag).
  • Cancel (empty WANT): precise reclaim + late-DATA guard: on sender failure/abort it sends an empty
    WANT; the receiver reclaimFlow immediately frees the flow's granted-but-unwritten regions
    (otherwise they stay held until peer loss, leaking on a long-running receiver), deferring any
    scattering ones. Correspondingly onData validates with heldByFlow: if an empty WANT raced ahead of
    a DATA so the region was freed/re-granted, that late DATA is dropped (never scatter a region now
    owned by someone else).
  • Scatter input validation (defense in depth): scatter runs come from the peer's DATA; before
    launch the receiver checks every run's source range lies within this flow's granted region, and
    that the expanded plan doesn't exceed local scratch capacity. Any out-of-bounds → no launch, no ACK.
  • CUDA errors: gather/scatter/sync return codes are not swallowed; errors WARN (with
    cudaGetErrorString).

Entry routing (transparent to callers; disabling is byte-equivalent to the original NIXL path):

flowchart TD
    S[submitTransferRequests] --> E{shouldUseBounce?<br/>WRITE + both-VRAM + no syncMsg<br/>+ peer handshake OK + descCount/avg<br/>+ per-side uniform deviceId}
    E -- no --> N[standard NIXL path]
    E -- yes --> SUB[submit: register Request + send WANT + eager gathers + return future]
    SUB --> POST[IO thread: GRANT→attach/gather+postWrite→DATA, pipelined]
    POST --> ERR{poll==kFailed / scatter fail / peer gone / stalled beyond requestTimeoutMs?}
    ERR -- yes --> F[Request → FAILURE]
    ERR -- no --> OK{all chunks poll SUCCESS AND all ACKed?}
    OK -- yes --> SU[wait = SUCCESS]
    F --> W[wait = FAILURE → caller task.fail]
Loading

Bootstrap: the bounce handshake blob is serialized with the AgentDesc (getLocalAgentDesc /
loadRemoteAgent(AgentDesc)registerPeerHandshake), i.e. the path production disagg already uses;
the first WANT starts directly with no separate handshake round-trip.

10. Configuration (env)

All prefixed TRTLLM_NIXL_BOUNCE_. Byte-valued variables accept case-insensitive binary suffixes
(K/KB/KiB, M/MB/MiB, G/GB/GiB; all powers of two), e.g. ARENA_SIZE_BYTES=512MB. Unparsable
values fall back to the default (never silently become 0).

Field env (suffix after prefix) Default Meaning
enabled ENABLE off Master switch.
arenaSizeBytes ARENA_SIZE_BYTES 256 MiB Shared region arena size.
arenaAllocationGranularityBytes ARENA_ALLOCATION_GRANULARITY_BYTES 1 MiB Buddy minimum block (allocation granularity).
maxChunkSizeBytes MAX_CHUNK_SIZE_BYTES 32 MiB Per-chunk byte cap (plan bin-pack cap); clamped to the arena's usable capacity if larger; must match the peer's (handshake-checked).
maxInflightChunksPerRequest MAX_INFLIGHT_CHUNKS_PER_REQUEST 8 Per-flow in-flight cap W (pipeline depth).
copyStreamCount COPY_STREAM_COUNT 8 ExecPool context count (GPU kernel concurrency cap).
scatterWorkerCount SCATTER_WORKER_COUNT 4 Scatter worker thread count.
minDescriptorCount MIN_DESCRIPTOR_COUNT 1024 Routing gate: minimum descriptor count.
maxAverageDescriptorSizeBytes MAX_AVERAGE_DESCRIPTOR_SIZE_BYTES 16 KiB Routing gate: maximum average descriptor bytes.
requestTimeoutMs REQUEST_TIMEOUT_MS 30000 No-progress timeout.
disableFabricMemory DISABLE_FABRIC_MEMORY off Use cudaMalloc instead of MNNVL fabric memory (CI/x86).
enableEagerGather ENABLE_EAGER_GATHER on Launch gathers at submit() before GRANT (overlap control RTT); eager staging capped at ½ arena.
useNixlNotifications USE_NIXL_NOTIFICATIONS off Control plane over NIXL notifications (UCX active messages) instead of ZMQ/TCP; must match the peer (handshake-checked).
useZeroCopyArguments USE_ZERO_COPY_ARGUMENTS on Copy kernel reads its plan directly from pinned host memory (no H2D staging).
useCubCopy USE_CUB_COPY off Use cub::DeviceMemcpy::Batched instead of the custom copy kernel (experimental).
disableScatterRunMerging DISABLE_SCATTER_RUN_MERGING off DEBUG ONLY: per-desc DATA plan instead of coalesced runs.

shouldUseBounce fires when: op is WRITE, src/dst are both VRAM, no syncMessage, the peer passed
the capability handshake, descCount ≥ minDescriptorCount, all srcs are on this agent's device and
all dsts on one device, and average desc bytes ≤ maxAverageDescriptorSizeBytes; otherwise the
standard NIXL path is used.

11. Test Coverage

Tests live under cpp/tests/unit_tests/executor/bounce/.

  • Pure logic (no GPU): buddyAllocatorTest (split/coalesce/fragmentation/boundaries/overflow),
    creditSchedulerTest (in-flight cap/fairness/drain-mode anti-starvation/reclaim/conservation/
    reclaim-defer/orphan/eager budget), bounceMessageCodecTest (round-trip/truncation/magic/
    cross-type-reject/large-count/handshake codec), bounceTransferPlanTest (bin-pack boundaries +
    scatter-run merging), bounceConfigTest (env parsing, byte suffixes, garbage fallback).
  • GPU unit: bounceArenaTest, execPoolTest, gatherScatterKernelTest (custom kernel /
    zero-copy args / cub backend).
  • Transport (real NIXL loopback + zmq): zmqControlChannelTest (incl. endpoint validation),
    bounceTransportTest (end-to-end, byte-exact; handshake compatibility; malformed-WANT rejection),
    bounceTransportFailureTest (no-GRANT timeout / engine failure / shutdown in-flight / forgetPeer
    in-flight / multi-peer shared-arena over-subscription no-deadlock / multi-threaded submit).
  • Real NIXL RDMA e2e: nixlTransferEngineTest; bounceNixlE2ETest (RealRdmaLoopback single
    transfer / ConcurrentBidirectionalRealRdma 8-thread bidirectional /
    MultiAgentManySendersToOneReceiver / ForgetPeerInFlightRecovers); bounceAgentE2ETest
    (production submitTransferRequests path: single transfer + ConcurrentSubmitUsesBounce).
    All e2e tests verify byte-exactly (seed-distinct pattern per transfer, ruling out cross-talk).
  • Python integration: test_cache_transceiver_single_process.py drives the NIXL bounce path
    through the Python cache transceiver (added to l0_h100.yml).

12. perf compare

https://docs.google.com/document/d/1J8ROqb1D-TQryIEyqLoYtP4Z3Hqk_7AreluczjdtH5w/edit?usp=sharing
gptoss gb200_gpt-oss-120b-fp4_8k1k_con128_ctx1_tp1_gen1_tp4_eplb0_mtp0_ccb-NIXL

con128

gen_side p50/p90/p99/mean (ms) max (ms)
py_bounce 10.1 / 108.6 / 116.7 / 25.1 2660
py_bounce_t1 9.8 / 113.6 / 119.3 / 40.5 2675
bounce_v2 4.2 / 5.0 / 6.0 / 4.3 201
bounce_v2_zmq 4.0 / 4.9 / 5.7 / 4.1 105

con1024

gen_side p50/p90/p99/mean (ms) max (ms)
py_bounce 10.2 / 113.6 / 119.1 / 38.0 2721
py_bounce_t1 10.1 / 116.8 / 120.3 / 45.0 2700
bounce_v2 4.5 / 5.5 / 6.3 / 4.6 509
bounce_v2_zmq 4.6 / 5.5 / 6.4 / 4.6 197

PR Checklist

Please review the following before submitting your PR:

  • PR description clearly explains what and why. If using CodeRabbit's summary, please make sure it makes sense.

  • PR Follows TRT-LLM CODING GUIDELINES to the best of your knowledge.

  • Test cases are provided for new code paths (see test instructions)

  • If PR introduces API changes, an appropriate PR label is added - either api-compatible or api-breaking. For api-breaking, include BREAKING in the PR title.

  • Any new dependencies have been scanned for license and vulnerabilities

  • CODEOWNERS updated if ownership changes

  • Documentation updated as needed

  • Update tava architecture diagram if there is a significant design change in PR.

  • The reviewers assigned automatically/manually are appropriate for the PR.

  • Please check this after reviewing the above items as appropriate for this PR.

GitHub Bot Help

To see a list of available CI bot commands, please comment /bot help.

@chuangz0
chuangz0 force-pushed the worktree-bounce-v2 branch from 5998a62 to 11e9711 Compare June 30, 2026 10:06
@chuangz0 chuangz0 changed the title Worktree bounce v2 [None][feat] cache transceiver nixl bounce buffer Jun 30, 2026
@chuangz0
chuangz0 force-pushed the worktree-bounce-v2 branch from 08c3277 to 006072a Compare July 1, 2026 11:16
@chuangz0

chuangz0 commented Jul 1, 2026

Copy link
Copy Markdown
Collaborator Author

/bot run --disable-fail-fast

@tensorrt-cicd

Copy link
Copy Markdown
Collaborator

PR_Github #56919 [ run ] triggered by Bot. Commit: 006072a Link to invocation

@tensorrt-cicd

Copy link
Copy Markdown
Collaborator

PR_Github #56919 [ run ] completed with state SUCCESS. Commit: 006072a
/LLM/main/L0_MergeRequest_PR pipeline #45725 completed with status: 'FAILURE'

CI Report

⚠️ Action Required:

  • Please check the failed tests and fix your PR
  • If you cannot view the failures, ask the CI triggerer to share details
  • Once fixed, request an NVIDIA team member to trigger CI again

CI Agent Failure Analysis

Link to invocation

@chuangz0
chuangz0 force-pushed the worktree-bounce-v2 branch 2 times, most recently from 7e44ece to 1214785 Compare July 2, 2026 09:01
@chuangz0

chuangz0 commented Jul 2, 2026

Copy link
Copy Markdown
Collaborator Author

/bot run --disable-fail-fast

@chuangz0
chuangz0 force-pushed the worktree-bounce-v2 branch from 1214785 to 40c5a3b Compare July 7, 2026 06:08
@chuangz0
chuangz0 force-pushed the worktree-bounce-v2 branch from fdff3d7 to b7c648d Compare July 24, 2026 07:50
@chuangz0

Copy link
Copy Markdown
Collaborator Author

/bot run --disable-fail-fast

@tensorrt-cicd

Copy link
Copy Markdown
Collaborator

PR_Github #61555 [ run ] triggered by Bot. Commit: b7c648d Link to invocation

@tensorrt-cicd

Copy link
Copy Markdown
Collaborator

PR_Github #61555 [ run ] completed with state FAILURE. Commit: b7c648d
/LLM/main/L0_MergeRequest_PR pipeline #49766 completed with status: 'FAILURE'

CI Report

⚠️ Action Required:

  • Please check the failed tests and fix your PR
  • If you cannot view the failures, ask the CI triggerer to share details
  • Once fixed, request an NVIDIA team member to trigger CI again

CI Agent Failure Analysis

Link to invocation

@chuangz0
chuangz0 force-pushed the worktree-bounce-v2 branch from 175552f to 2aef331 Compare July 27, 2026 02:35
@chuangz0

Copy link
Copy Markdown
Collaborator Author

/bot run --disable-fail-fast

@tensorrt-cicd

Copy link
Copy Markdown
Collaborator

PR_Github #61779 [ run ] triggered by Bot. Commit: 2aef331 Link to invocation

@tensorrt-cicd

Copy link
Copy Markdown
Collaborator

PR_Github #61779 [ run ] completed with state FAILURE. Commit: 2aef331
/LLM/main/L0_MergeRequest_PR pipeline #49979 completed with status: 'FAILURE'

CI Report

⚠️ Action Required:

  • Please check the failed tests and fix your PR
  • If you cannot view the failures, ask the CI triggerer to share details
  • Once fixed, request an NVIDIA team member to trigger CI again

CI Agent Failure Analysis

Link to invocation

@chuangz0
chuangz0 force-pushed the worktree-bounce-v2 branch 2 times, most recently from 9eba889 to 5e6080e Compare August 3, 2026 03:00
@chuangz0
chuangz0 force-pushed the worktree-bounce-v2 branch 2 times, most recently from 136d661 to be9dd02 Compare August 10, 2026 07:09
@chuangz0
chuangz0 marked this pull request as ready for review August 10, 2026 07:49
@chuangz0
chuangz0 requested review from a team as code owners August 10, 2026 07:49
…gine + agent integration

The reactor and wiring on top of the core building blocks:
- BounceTransport: one IO thread + M scatter workers; decomposed into BounceContext
  (shared deps + the one CreditScheduler + sendGrants), BounceSender ([S]: submit ->
  WANT, GRANT -> gather+RDMA-write, ACK -> resolve), BounceReceiver ([R]: WANT ->
  grant regions, DATA -> scatter, ACK). No notifMsg: getXferStatus==SUCCESS ⇒ landed.
- ControlChannel + ZmqControlChannel: ROUTER recv + per-peer DEALER send; non-blocking
  send (drop on full SNDHWM), routable-IP bind (common::getLocalIp, IPv4/IPv6).
- TransferEngine + NixlTransferEngine (production RDMA over the same nixlAgent) +
  LocalCopyTransferEngine (loopback for tests).
- NixlTransferAgent integration: maybeInitBounce (arena+exec+transport, register arena,
  bind a routable control endpoint), shouldUseBounce routing, AgentDesc carries the
  bounce endpoint, WANT self-bootstraps the reverse control path, invalidateRemoteAgent
  -> forgetPeer; opt-in via TRTLLM_NIXL_BOUNCE_ENABLE (disabled path byte-identical).
- common::FabricMemory extracted from batch_manager for the fabric-backed arena.
With unit + real-NIXL-RDMA e2e tests (zmq, transport, failure, nixl-engine, nixl e2e,
agent e2e). Build gated on ENABLE_UCX (-DTLLM_BOUNCE_V2).

Signed-off-by: Chuang Zhu <111838961+chuangz0@users.noreply.github.com>
Lean as-built design doc for bounce v2: motivation, module map, control-plane
(credit flow + fair scheduling) and data-plane pipeline, single-IO-thread model,
sequence + state diagrams (region lifecycle, sender Request state machine),
error handling / lifecycle, config env vars, and test coverage. Mermaid validated.

Signed-off-by: Chuang Zhu <111838961+chuangz0@users.noreply.github.com>
Resource-cleanup paths discarded their results, hiding leaks/faults. Use the
project's idiomatic warn-only cleanup check (TLLM_CUDA_CHECK_WARN, as in tllmBuffers
/ cudaMemPool / ncclUtils) for the CUDA teardown/thread-pin calls that must not throw,
and explicit status/throw checks for the NIXL ones (no equivalent macro):
- ExecPool::~ExecPool / BounceArena::~BounceArena: cudaSetDevice + cudaFree/cudaFreeHost
  /cudaStreamDestroy/cudaEventDestroy were (void)-discarded -> TLLM_CUDA_CHECK_WARN.
- LocalCopyTransferEngine: cudaEventDestroy (dtor / record-fail / release) -> TLLM_CUDA_CHECK_WARN.
- BounceTransport: ioLoop/scatterWorker thread-pin cudaSetDevice + shutdown cudaSetDevice/
  cudaDeviceSynchronize (can't throw out of a thread fn / dtor) -> TLLM_CUDA_CHECK_WARN.
- NixlTransferEngine: releaseXferReq (dtor / postWrite-error / release) sat in empty
  catch(...){}, and deregisterMem discarded its status -> a shared releaseXferLogged
  helper + deregisterMem now check the nixl_status and catch+log throws.
- maybeInitBounce: cudaGetDevice failure silently used device 0 -> warn.

Kept explicit (the cudaError_t drives control flow, not just a warning): the scatter
worker's launch/stream-sync (ok/!ok -> ACK or not) and the gather event-query path.
The three promise->set_value() catch(...) blocks are commented as intentional (throws
only if already satisfied — benign double-resolve). No behavior change on success; all
bounce tests green (incl. real-RDMA e2e).

Signed-off-by: Chuang Zhu <111838961+chuangz0@users.noreply.github.com>
Bounce's real dependencies are NIXL (data plane) + zmq (control plane); UCX is
orthogonal. It was only compiled under if(ENABLE_UCX) because cppzmq happened to be
fetched there (UCX's own bootstrap also uses zmq), so a NIXL-without-UCX build
couldn't get bounce even though its deps were satisfiable.

- cpp/CMakeLists.txt: FetchContent cppzmq when (NIXL_ROOT OR ENABLE_UCX), not only
  ENABLE_UCX; ucxx stays UCX-only.
- nixl_utils/CMakeLists.txt: gate the bounce sources on zmq availability
  (pkg_check_modules(ZMQ libzmq), non-REQUIRED -> ZMQ_FOUND) instead of ENABLE_UCX,
  inside the existing NIXL_ROOT block. Skips cleanly when libzmq is absent.
- tests/.../executor/CMakeLists.txt: same — bounce tests gated on ZMQ_FOUND (+ the
  fetched cppzmq header), not ENABLE_UCX.

Validated: reconfigure clean; bounce still wired (TLLM_BOUNCE_V2 + sources) in the
default NIXL+UCX build; full bounce build + 84 gtests pass through the new gate.

Signed-off-by: Chuang Zhu <111838961+chuangz0@users.noreply.github.com>
§5 of DESIGN.md gains a plain-language "直观理解" of schedule() (the queue-ticket
metaphor for the three constraints: round-robin fairness / per-flow window W / arena
backpressure) plus a worked A/B example table showing the strict A,B,A,B grant order
and the c3-waits-for-ACK case. schedule() gets a function-level comment spelling out
the same three rules and the one-grant-per-sweep + advance-cursor rotation, and inline
notes on the while-loop and the break. Comments/doc only — no behavior change.

Signed-off-by: Chuang Zhu <111838961+chuangz0@users.noreply.github.com>
…ancelWant)

"empty WANT == cancel" was an implicit convention at the call sites. Make it explicit
without touching the wire: encodeCancel(rid, endpoint) is a thin wrapper over
encodeWant(rid, {}, endpoint), and isCancelWant(chunkBytes) replaces the inline
chunkBytes.empty() check on the receiver. Same bytes (still a WANT), so it reuses
onWant's reclaim/self-bootstrap path. Codec test updated to exercise both helpers
(+ a non-empty WANT is-not-cancel case). Call sites adopt encodeCancel in the next
commit (shared file BounceTransport.cpp).

Signed-off-by: Chuang Zhu <111838961+chuangz0@users.noreply.github.com>
…ckends

Two off-by-default knobs for the gather/scatter descriptor copy (default = current
custom kernel + H2D of the plan arrays, unchanged):
- TRTLLM_NIXL_BOUNCE_CUB_COPY: use cub::DeviceMemcpy::Batched (tuned load-balancing
  across heterogeneous buffer sizes) instead of the custom kernel. ExecPool pre-sizes a
  per-context cub workspace (batchedCopyCubTempBytes for maxDescs).
- TRTLLM_NIXL_BOUNCE_ZEROCOPY_ARGS: kernel reads the [srcs|dsts|sizes] plan arrays
  straight from mapped pinned host (cudaHostAllocMapped + cudaHostGetDevicePointer),
  skipping their H2D. Likely a loss for large n (PCIe reads in-kernel) — provided for
  A/B benchmarking, not as a default.
launchPacked composes the two (arg source x copy backend); BounceConfig carries the
flags; ExecPool allocates the workspace / mapped host accordingly. Also switches the
cancel call sites to encodeCancel (helper added previously).

Tested: gatherScatterKernelTest gains byte-exact cub / zero-copy / both round trips;
bounceAgentE2ETest passes over real RDMA in all four off/cub/zerocopy/both combos;
full 84-test bounce suite green with both knobs OFF (no regression).

Signed-off-by: Chuang Zhu <111838961+chuangz0@users.noreply.github.com>
… forgetPeer)

The real-NIXL e2e suite was happy-path only; failure/cancel were covered only via the
LocalCopy loopback (bounceTransportFailureTest). Add two failure cases over the real
NIXL stack, with a shared makeNode()/wirePair() harness helper:
- NoGrantTimesOutNotHang: WANT to a control endpoint with no live receiver -> the
  request must resolve kFAILURE on leaseTimeout (short 1.5s), not hang.
- ForgetPeerInFlightRecovers: forgetPeer() right after submit -> the request resolves
  (SUCCESS if it beat the queued reclaim, else FAILURE), never hangs; then 5 fresh
  transfers to the same peer complete byte-exact, proving reclaim returned the regions
  and left the reactor healthy (a leak would soon exhaust the small arena).
Both deterministic/non-flaky (verified across repeated runs). bounceNixlE2ETest now 5
tests; full bounce suite green. (Real mid-flight NIXL transfer failure / poll==kFailed
is hard to inject deterministically — still only covered via LocalCopy.)

Signed-off-by: Chuang Zhu <111838961+chuangz0@users.noreply.github.com>
forgetPeer/drainForgets reclaimed scheduler flows and failed in-flight
requests, but never dropped the ControlChannel's per-peer DEALER socket,
so a forgotten peer's send-side socket/endpoint lingered until shutdown.

Add removePeer() to the ControlChannel interface, implement it in
ZmqControlChannel (erase the dealer under the same mutex sendTo() holds),
and call it in drainForgets() after the receiver/sender forget() (which
may emit a final cancel WANT). A later transfer re-establishes the dealer
via addPeer() or the WANT self-bootstrap. Update ForgetPeerInFlightRecovers
to re-addPeer before recovery, matching the new full-forget semantics.

Signed-off-by: Chuang Zhu <111838961+chuangz0@users.noreply.github.com>
The executor unit-test dir was a flat 33-file directory with ~13 of those
being NIXL bounce-buffer v2 tests. Move them into a dedicated
tests/unit_tests/executor/bounce/ subdirectory (mirroring the source layout
under nixl_utils/bounce/) with its own CMakeLists.txt, and replace the inline
bounce block in executor/CMakeLists.txt with add_subdirectory(bounce).

Pure file moves + build-script relocation; no test logic changes. The subdir
self-gates on zmq (pkg_check_modules) and NIXL_ROOT, so the parent descends
unconditionally. The non-bounce nixl/ucx/mooncake agent tests (agentCommTest,
transferAgentTest, coalesceTest, ucxComm*) stay in the parent.

Signed-off-by: Chuang Zhu <111838961+chuangz0@users.noreply.github.com>
ForgetPeerInFlightRecovers was flaky (~15% under full-suite load, never in
isolation): after forgetPeer drops a peer's DEALER, all 5 recovery transfers
hit leaseTimeout. Two root causes, both in the forget/re-add path introduced
when removePeer was added to forgetPeer:

1. ROUTER identity collision on reconnect. DEALERs identify by a fixed agent
   name (routing id). When a peer is forgotten (DEALER dropped) and re-added,
   it reconnects with the SAME identity; by default a ROUTER rejects a new
   connection whose identity matches an existing (not-yet-reaped) one and
   silently drops its messages -> the re-added peer's WANTs vanish. Set
   ZMQ_ROUTER_HANDOVER=1 so the ROUTER hands the identity to the new
   connection. This is the primary fix and is production-relevant (a real
   peer that reconnects under the same agent name).

2. removePeer ran on the IO thread (drainForgets), racing the caller's
   addPeer after forgetPeer returned -> the re-add could be a no-op that the
   trailing removePeer then erased. Drop the DEALER synchronously in
   forgetPeer instead, giving a deterministic happens-before for a later
   addPeer; keep only the scheduler/request reclaim on the IO thread.

Verified: 70/70 full-suite runs green (was ~6/20 failing); forget + zmq unit
tests still pass.

Signed-off-by: Chuang Zhu <111838961+chuangz0@users.noreply.github.com>
Keep the as-built design notes on disk for local reference but remove them
from version control.

Signed-off-by: Chuang Zhu <111838961+chuangz0@users.noreply.github.com>
…calCopy fake

The bounce transport/failure unit tests used LocalCopyTransferEngine, a
same-process D2D loopback stand-in for the data plane. Since CI provides NIXL,
exercise the real data path instead and remove the fake:

- New shared helper bounceTestNixlNode.h: a full bounce node (NixlTransferAgent
  + NixlTransferEngine + arena + exec + zmq channel + transport) plus seeded
  device buffers and a byte-exact verifier.
- bounceTransportTest / bounceTransportFailureTest now build NIXL nodes and move
  data over real RDMA (skip if no CUDA / NIXL backend). The CMake reactor source
  set links NixlTransferEngine.cpp (not LocalCopyTransferEngine.cpp); these tests
  move into the NIXL_ROOT + zmq block. zmqControlChannelTest stays zmq-only.
- Keep a tiny FailingTransferEngine (poll()==kFailed) only for
  EngineFailureFailsRequest: a real NIXL engine cannot be coerced into a
  deterministic write failure, and it moves no data (no agent needed).
- Delete LocalCopyTransferEngine.{h,cpp} (test-only; never in the wrapper) and
  clean up stale references in comments.

Signed-off-by: Chuang Zhu <111838961+chuangz0@users.noreply.github.com>
Make the bounce e2e tests faithful to how disaggregation wires agents in
tensorrt_llm/_torch/disaggregation/native/transfer.py, and remove coverage
that duplicated the production path or tested nothing at runtime.

bounceAgentE2ETest (production entry NixlTransferAgent::submitTransferRequests):
- Use the real one-directional AgentDesc bootstrap: only the sender loads the
  receiver; the receiver self-bootstraps each sender from its WANT
  (BounceReceiver::onWant). Dropping the receiver-side loadRemoteAgent is what
  actually exercises that reverse-control self-bootstrap path.
- Migrate the bidirectional-concurrency and many-senders-to-one-receiver
  scenarios here (ConcurrentBidirectionalUsesBounce,
  MultiAgentManySendersToOneReceiver) so they run over the production API with
  the production bootstrap instead of a hand-wired transport.

bounceNixlE2ETest: keep only the white-box failure/edge tests that must inject
faults the public API can't reach (NoGrantTimesOutNotHang,
ForgetPeerInFlightRecovers). Drop RealRdmaLoopback / the bidirectional and
multi-agent happy-path tests now covered by bounceAgentE2ETest.

bounceTestNixlNode.h / bounceNixlE2ETest: the white-box harness now bootstraps
NIXL metadata via getLocalAgentDesc (the production path) instead of
getLocalConnectionInfo, which disagg never uses.

Remove nixlTransferEngineTest: a construct-with-null smoke test with no runtime
coverage whose compile/link check is already provided by the reactor tests and
the production wrapper.

Signed-off-by: Chuang Zhu <111838961+chuangz0@users.noreply.github.com>
Three correctness hardenings found in an adversarial review of the transport,
plus a regression test.

- Clamp maxChunkBytes to the arena's USABLE capacity at construction. The buddy
  allocator rounds usable capacity DOWN (to minBlock<<maxOrder) and rounds each
  request UP to a power of two, so the naive "maxChunkBytes <= arenaBytes" is not
  sufficient: a chunk sized to the unclamped cap can round past usable capacity,
  never get granted, and hang the flow to leaseTimeout. Expose the drained-arena
  capacity via CreditScheduler::arenaCapacity() and clamp (with a warning).

- Guard the sender credit<->chunk pairing: credits pair with chunks by FIFO
  order and the control channel does not guarantee GRANT ordering, so a reordered
  GRANT could pair a chunk with a smaller region and make the RDMA write overflow
  into an adjacent flow's region on the peer. Detect packedBytes > credit.len and
  abandon the flow (fails via checkTimeouts) instead of corrupting the peer.

- Scope the receiver's scatter bounds check to the flow's own granted region
  (its buddy block) instead of the whole arena, so a bad/reordered DATA whose
  bounceOffset points past the region cannot read an adjacent flow's data into
  this flow's KV. Carry the region size through onData into the ScatterJob via
  CreditScheduler::regionBytes().

Regression test BounceTransport.MaxChunkBytesClampedToUsableArena: a 96KiB arena
(64KiB usable) with maxChunkBytes=96KiB must still complete an 80KiB transfer
byte-exact (hangs to timeout without the clamp).

Also drops the dangling DESIGN.md section references from these files (the design
doc is not part of the tree).

Signed-off-by: Chuang Zhu <111838961+chuangz0@users.noreply.github.com>
…ents

The as-built design doc is not part of the tree, so remove the "(DESIGN)" tags
and "DESIGN.md §N" section pointers from code comments (keeping the substantive
explanations) and repoint the test comments at the code symbol
(BounceReceiver::onWant) instead of a doc section.

Signed-off-by: Chuang Zhu <111838961+chuangz0@users.noreply.github.com>
TRTLLM_NIXL_BOUNCE_{ARENA_BYTES,MIN_BLOCK,MAX_CHUNK_BYTES,MAX_AVG} now
parse an optional case-insensitive binary suffix (K/KB/KiB, M/MB/MiB,
G/GB/GiB, all powers of two), e.g. 256MB or 1gb. Garbage values and
multiply overflow fall back to the default, same rationale as envU64.
Non-byte vars keep strict integer parsing. Covered by bounceConfigTest.

Signed-off-by: Chuang Zhu <111838961+chuangz0@users.noreply.github.com>
Add BounceNvtx.h: a dedicated trtllm.disagg.bounce NVTX domain with RAII
scoped spans and cross-thread start/end spans (plain uint64 handles
carried in the reactor structs, ended on another thread / a later poll).
All spans use start/end style, so nsys-ui shows them in one process-level
domain row. Compiled out under NVTX_DISABLE (the default); enable with
build_wheel.py --nvtx.

Spans: buildPlan, req (submit->resolve), grantWait (WANT->first GRANT),
gatherLaunch, gather (launch->event), nixlWrite (post->Done), ackWait
(DATA->ACK), scatterQueue (enqueue->dequeue), scatter (kernel+sync), and
the pipeline-starvation periods creditStarved / arenaStarved. Failure
paths (failRequest/failAll/forget/shutdown) close every open span. The
IO thread and scatter workers are named for profiler timelines.

Add SenderArenaBackpressureParksCredits: asymmetric arenas force granted
credits to park on the sender and drain via drainPendingPosts (also the
arenaStarved path); the transfer must still complete byte-exact.

Signed-off-by: Chuang Zhu <111838961+chuangz0@users.noreply.github.com>
…s -> 0.85ms)

Measured on gpt-oss-120b 8k1k con128 disagg (ctx tp1 -> gen tp4, GB200,
72MB/18432-desc chunks), per-chunk NVTX A/B across rounds 17-23:

- ExecPool: greatest-priority streams (gather kernel queueing 262us -> 150us)
- Scatter plan compression: coalesce descs into contiguous or uniformly
  strided BounceScatterRun entries (wire v2); DATA message 442KB -> 36B for
  both dense (tp1->tp4) and strided (tp4->dp) dst layouts
- Split large runs back to 64KB pieces at kernel-launch time (keeps the
  one-thread-block-per-entry parallelism; scratch-budgeted)
- Scatter workers send ACK directly (skips the done-queue -> IO-thread hop)
- Eager gather (TRTLLM_NIXL_BOUNCE_EAGER_GATHER, default on): launch the
  gather at submit() so it overlaps the WANT->GRANT round-trip; eager
  staging capped at half the arena to keep bidirectional grants live
- Fill plan arrays directly into the exec ctx pinned buffer (drops the
  intermediate vectors + memcpy per chunk)
- NixlNotifControlChannel (TRTLLM_NIXL_BOUNCE_NIXL_CONTROL, default off):
  control messages over NIXL genNotif/getNotifs (UCX AM) instead of
  ZMQ/TCP; ackWait 359us -> 278us small-msg, 721us -> 491us at 664KB
- Fine-grained NVTX spans decomposing the ackWait critical path
- TRTLLM_NIXL_BOUNCE_NO_RUN_MERGE debug knob for control-plane A/B

Signed-off-by: Chuang Zhu <111838961+chuangz0@users.noreply.github.com>
Signed-off-by: Chuang Zhu <111838961+chuangz0@users.noreply.github.com>
Erasing the LAST flow from the round-robin ring left
`mCursor %= mRing.size()` to execute with size()==0 -- modulo by zero
(UB; a deterministic SIGFPE in -O0 builds, silently folded away at -O2).
Any normal completion or reclaim of the only active flow hits this path.

Reset the cursor and return early when the ring empties; the non-empty
path is unchanged. Add a regression test that drains a single flow to
empty the ring and verifies scheduling still rotates fairly on refill.

Signed-off-by: Chuang Zhu <111838961+chuangz0@users.noreply.github.com>
Signed-off-by: Chuang Zhu <111838961+chuangz0@users.noreply.github.com>
Signed-off-by: Chuang Zhu <111838961+chuangz0@users.noreply.github.com>
Signed-off-by: Chuang Zhu <111838961+chuangz0@users.noreply.github.com>
Signed-off-by: Chuang Zhu <111838961+chuangz0@users.noreply.github.com>
- BounceTransport: exception boundary around the IO reactor tick; plan-entry
  capacity guard on the gather path; submit() resolves plan-build failures to
  kFAILURE instead of throwing out of submitTransferRequests
- shouldUseBounce: screen every plan precondition (src/dst length pairs,
  per-descriptor size cap, per-side device uniformity) so ineligible requests
  fall back to the standard NIXL path
- NixlNotifControlChannel: genNotif no longer runs under the channel mutex
- ExecPool: constructor cleans up already-allocated CUDA resources on failure
- BounceMessage: decodeHandshake bounds the endpoint length so malformed blobs
  return false instead of throwing
- BounceConfig: document that REQUEST_TIMEOUT_MS <= 0 disables the timeout
- tests: dedupe bounceNixlE2ETest via bounceTestNixlNode.h, CUDA guard in
  ZeroBuffersIsNoop, brace style fixes, owner-map assert, cppzmq CMake gate,
  pin UCX env in the Python transceiver test

Signed-off-by: Chuang Zhu <111838961+chuangz0@users.noreply.github.com>
The Python transceiver test asserted two log strings in the child's stdout,
which required TLLM_LOG_LEVEL_BY_MODULE=debug:executor. A non-empty per-module
level map can hang the child at exit (~15% repro in batch runs): static
destruction order lets CudaMemPool's deleter TLLM_LOG_TRACE through an
already-destroyed Logger module map, and the corrupted std::map::find never
returns, so the child spins until the 180s subprocess timeout.

Replace log parsing with a programmatic probe:
- NixlTransferAgent::isBounceEnabled() / getBounceSubmitCount() (atomic
  counter bumped when a request is routed to the bounce fast path), exposed
  as bounce_enabled / bounce_submit_count on the nanobind agent and the
  Python wrapper — also usable for deployment checks
- the test asserts them inside the child (all agents bounce-enabled, total
  submit count > 0) and the parent only checks the child's exit code; the
  by-module log env and both string assertions are gone

The Logger static-destruction hang itself is a pre-existing main-library
issue and will be addressed separately.

Signed-off-by: Chuang Zhu <111838961+chuangz0@users.noreply.github.com>
Signed-off-by: Chuang Zhu <111838961+chuangz0@users.noreply.github.com>
Signed-off-by: Chuang Zhu <111838961+chuangz0@users.noreply.github.com>
@chuangz0
chuangz0 force-pushed the worktree-bounce-v2 branch from 2d50931 to 4113f16 Compare August 12, 2026 07:18
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.

4 participants