Filename + lifecycle:
- ADR rename to ADR-NNNN-<cat>-title.md with 8 3-letter category prefixes
(dev / mem / lat / prog / algo / par / api / ver). Numbers stay immutable.
- ADR Lifecycle split into 3 folders, documented in CLAUDE.md Part 2:
docs/adr/ (Accepted), docs/adr-proposed/ (Proposed/Stub/Draft),
docs/adr-history/ (Superseded/Merged). Status field gains "Draft" for
retroactive docs pending verification.
Merges (one ADR per topic, no change-history annotations):
- ADR-0017 absorbs ADR-0019 (Cube NOC + per-PE HBM connectivity, 10 D-items)
- ADR-0014 absorbs ADR-0021 (PE pipeline execution model, 8 D-items incl.
TileToken self-routing and multi-op composite epilogue scope)
- ADR-0023 absorbs docs/ipcq-dma-codesign-hw.md as new "HW Realization
Notes (Informative)" section (D16-D23 + Open HW Questions). codesign-hw.md
deleted; ADR-0019/0021 moved to adr-history with one-line stub status
Retroactive documentation (G4 closures, code-verified):
- ADR-0037 forwarding component (TransitComponent: first-flit overhead,
serial worker, path-based routing, single impl/multiple names)
- ADR-0036 IO_CPU component (target_start_ns global barrier stamping,
per-cube fan-out, response aggregation)
- ADR-0035 M_CPU & M_CPU.DMA component (3 fan-out paths, DMA Resources,
target_start_ns passthrough)
- ADR-0034 HBM controller internal design (per-PC state, address-based
selection, flit-aware per-flit commit, async finalize, command-only
fallback path)
Content updates:
- ADR-0010 expanded to full CLI surface (run/probe/web), retitled
"Command Line Interface and Execution Semantics"
- ADR-0007 D2 rewritten to current state; ADR-0015 supersession notes pruned
- ADR-0005 wrapped in Decision header with D1-D5; ADR-0022 metadata
block replaced with standard Status header
- ADR-0024 trimmed to rank=SIP launcher essentials (D1-D4);
ADR-0027 cleaned of supersession history
- ADR-0033 D6 cleanup: address-based PC selection moved out of future-work
(now documented in ADR-0034 D3); related D1/D3 wording realigned
- Cross-references back-filled in 5 ADRs (G3 gaps closed)
Onboarding docs split:
- docs/onboarding/ created
- moved: hw-architecture-overview.md, latency-model.md, di-presentation.md,
ccl-author-guide{,.en}.md
- references updated in README, ADR-0023{,.en}, src/kernbench/ccl/__init__.py
Source / test / yaml: ADR-NNNN cross-references in docstrings and YAML
comments updated after the merges (ADR-0021->0014 D6, ADR-0019->0017 D8).
No behavior change.
Tooling:
- tools/verify_adr_lang_pairs.py + tests/test_verify_adr_lang_pairs.py
(ADR EN/KO pair invariant checker)
- .claude/commands/report.md tracked (/report slash command)
- .gitignore: allow .claude/commands/*.md while keeping settings files ignored
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
11 KiB
ADR-0034: HBM Controller Internal Design
Status
Accepted
Context
HbmCtrlComponent is the per-PE HBM partition endpoint at the leaf of
the cube NOC. One instance is created per PE under the topology node
sip{S}.cube{C}.hbm_ctrl.pe{idx} and attaches to that PE's router
(ADR-0017 D4). The component models per-pseudo-channel (PC) scheduling,
burst-granular commit timing, address-based PC selection, and response
routing back to the requester.
This ADR documents the component as currently implemented. ADR-0017 D4/D8 defines where HBM CTRL attaches and what aggregate BW it must deliver. ADR-0033 D1/D2 defines what fidelity of HBM modelling is in scope. This ADR fills the gap between those two — the per-instance internal scheduling model.
Decision
D1. Role
HbmCtrlComponent is a per-PE HBM partition endpoint. One instance per
PE (default 8 per cube, set by cube.memory_map.hbm_slices_per_cube)
attaches to that PE's router via the peX.hbm attachment list in
cube_mesh.yaml (ADR-0017 D4). In the default n:1 channel mapping
(ADR-0017 D8) the instance aggregates channels_per_pe pseudo-channels
into one endpoint.
The component models:
- Per-PC scheduling (D2) with R/W command-bus sharing.
- Address-based PC selection (D3).
- Burst-granular commit timing (D4).
- Flit-aware per-flit PC commit and async finalize (D5, D6).
- Command-only Transaction handling for read-data drain (D7).
- Response routing back to the requester (D8).
It does not model:
- Bank-level row-buffer conflicts, refresh, ECC, thermal throttling (ADR-0033 D3).
- Cross-PE HBM contention beyond its own router edge (handled by the router mesh — ADR-0017 D3).
- 1:1 channel mode (ADR-0017 D8 future work).
D2. Per-PC scheduling model
Per-instance state initialised in start():
_pc_avail: list[float]— earliest sim-time each PC is free; lengthnum_pcs, initial 0.0._pc_last_dir: list["R"|"W"|None]— direction of the last commit on each PC, used for switch-penalty detection (D4); initialNone.
num_pcs and burst_bytes must each be a positive power of two so
that address-based PC selection (D3) reduces to a shift-and-mask.
Read and write requests share the same _pc_avail slot per PC — the
real HW per-PC command bus is shared between read and write traffic, so
issuing a write to PC k blocks a subsequent read to PC k by exactly the
burst time.
Direction dir for a request is inferred from the request type:
MemoryWriteMsg→"W".PeDmaMsgwithis_write=True→"W".- All others (
MemoryReadMsg,PeDmaMsgread) →"R".
D3. Address-based PC selection
PC index for an access is derived from the access address by shift and mask:
pc_shift = log2(burst_bytes) # default 8 (burst=256B)
pc_mask = num_pcs - 1 # default 7 (8 PCs)
pc = (address >> pc_shift) & pc_mask
Computed once in start() from topology config so alternative
(burst_bytes, num_pcs) pairs stay consistent. For the canonical
default (256, 8) this places the PC select field at bits [10:8] of
the HBM byte offset: bits [7:0] are within-burst (same PC), bits
[10:8] are the 3-bit PC index, bits [36:11] are row/bank/column
within the PC slice (see phyaddr.py comment).
Address-based striping — as opposed to address-blind global round-robin — preserves PC parallelism for offset-disjoint concurrent transfers: each transfer's bursts land deterministically on the PC set implied by its byte addresses, so multi-PE workloads accessing disjoint regions do not collide on a single PC.
D4. Burst granularity and PC commit timing
A single PC commit takes:
chunk_time = burst_bytes / pc_bw_gbs # ns
burst_bytes(default 256) is the burst granularity matching the flit size (ADR-0033 D1).pc_bw_gbsis builder-derived fromhbm_to_router_bw_gbs / num_pcs(topology/builder.py), enforcing the ADR-0017 D8 invariant that aggregate per-PE BW equals the router-to-HBM link BW.
Per-PC commit scheduling for an arriving access on PC pc with
direction dir:
switch_cost = switch_penalty_ns
if pc_last_dir[pc] not in (None, dir) else 0
start = max(env.now, pc_avail[pc]) + switch_cost
finish = start + chunk_time
pc_avail[pc] = finish
pc_last_dir[pc] = dir
Default switch_penalty_ns = 0 — Tier 0 assumption that an ideal HBM
scheduler amortises R/W switching cost (ADR-0033 D2). Non-zero values
model pessimistic per-alternation cost.
D5. Flit-aware per-flit PC commit (primary path)
_handle_flit is the primary worker path. For each arriving Flit:
- On the first flit of a transaction (
tid = id(txn)not in_txn_state):- Apply
overhead_nsonce viarun(env, nbytes)— header decode model, first-flit overhead pattern (ADR-0033 D1). - Initialise
_txn_state[tid] = {"last_finish": env.now}.
- Apply
- Compute
pc = _pc_for_address(flit.address)(D3). - Apply the per-PC schedule (D4) using the request direction (D2).
- Update
state["last_finish"] = max(state["last_finish"], finish). - If
flit.is_last: pop_txn_state[tid]and spawn_finalize_txn(D6).
Per-flit address-aware commit is the mechanism that lets concurrent multi-PE traffic to disjoint HBM offsets pipeline through distinct PCs in parallel.
D6. Async finalize per transaction
When a transaction's last flit has been scheduled, finalisation runs in a separately-spawned process:
def _finalize_txn(env, txn, last_finish):
wait = last_finish - env.now
if wait > 0:
yield env.timeout(wait)
yield from _send_response(env, txn)
_handle_flit spawns this via env.process(...) and returns
immediately, so the worker can pick up the next inbox message while the
last PC commit drains.
Without this split — i.e. if the worker itself did
yield env.timeout(wait) — concurrent single-flit transactions whose
addresses hit distinct PCs would still serialise at chunk_time each
inside the worker, hiding the PC parallelism that D3 and D5 are
designed to expose.
D7. Non-flit fallback for command-only transactions
_handle_txn runs when the inbox delivers a Transaction rather than a
Flit. This is the path for command-only requests that the wire does
not chunk into flits — most notably MemoryReadMsg whose command txn
carries nbytes=0 (data drain is modelled at HBM CTRL post-processing,
not as inbound flits).
Procedure:
work_bytes = txn.nbytes if txn.nbytes > 0 else int(request.nbytes or 0)— for read commands, work is sized by the request.n_chunks = ceil(work_bytes / burst_bytes)ifwork_bytes > 0else 0.chunk_interval = drain_ns / n_chunks(when both > 0) — chunks are scheduled over time atdrain/n_chunksns intervals to model the bottleneck-link's data arrival rate (ADR-0033 D1 chunk-loop drain).- Apply
run(env, txn.nbytes)once foroverhead_ns. - For each chunk
i, advancechunk_intervalns then apply the D4 schedule withpc = _pc_for_address(base_address + i * burst_bytes). - After scheduling all chunks, wait
last_finish - env.nowthen call_send_response.
_handle_txn shares the same _pc_avail / _pc_last_dir state with
_handle_flit — there is exactly one source of PC scheduling truth
across both paths.
D8. Response routing
_send_response dispatches on request type and path geometry:
| Case | Trigger | Response |
|---|---|---|
| PE_DMA | isinstance(txn.request, PeDmaMsg) |
New reverse-path Transaction (is_response=True, nbytes=0), same done |
| Bypass — Memory Read | "m_cpu" not in any(txn.path) AND MemoryReadMsg |
Reverse-path Transaction with nbytes=request.nbytes (data return) |
| Bypass — Memory Write | "m_cpu" not in any(txn.path) AND not Memory Read |
txn.done.succeed() (write completes locally) |
| Default | otherwise | New ResponseMsg(correlation_id, request_id, src_cube, src_pe, success=True) on reverse path |
The "bypass" classification matches the Memory R/W fabric path defined in ADR-0015 D4 (PCIE_EP → io_noc → ucie → cube router → hbm_ctrl, without M_CPU). The PE_DMA case is its own dedicated reverse-path to keep the inner-loop DMA fast (PE_DMA reads/writes do not synthesise a ResponseMsg envelope).
In all reverse-path cases, the response Transaction is put onto
out_ports[reverse_path[1]] — the first hop back along the recorded
forward path. If reverse_path has fewer than 2 entries (degenerate
path), the original txn.done is signalled directly.
D9. Configurable attributes
| Attribute | Default | Source | Notes |
|---|---|---|---|
num_pcs |
8 | topology cube hbm_ctrl.attrs |
Must be power of 2 |
pc_bw_gbs |
32.0 | builder-derived: hbm_to_router_bw_gbs / num_pcs |
Enforces ADR-0017 D8 invariant |
burst_bytes |
256 | topology attrs | Must be power of 2; equals flit_bytes (ADR-0033 D1) |
switch_penalty_ns |
0.0 | topology attrs | Tier 0 default; non-zero models pessimistic R/W switching |
efficiency |
1.0 | topology attrs | Applied at builder time to hbm_to_router_bw_gbs (router-edge BW scaling only) |
overhead_ns |
0.0 | topology attrs | First-flit decode overhead (D5) |
pc_bw_gbs is derived by topology/builder.py rather than configured
directly so the aggregate per-PE BW matches the router-to-HBM link BW
without yaml-side duplication.
Consequences
Positive
- Address-based PC selection preserves multi-stream HBM parallelism that an address-blind round-robin would collapse — important for multi-PE workloads with disjoint HBM regions.
- Flit-aware path (D5) + async finalize (D6) preserves wormhole pipelining and exposes PC parallelism for back-to-back single-flit transactions.
- Single source of PC scheduling truth (D4 mechanism, used by both D5 flit path and D7 chunk-loop path).
- Builder-derived
pc_bw_gbsenforces ADR-0017 D8 in code, not yaml discipline.
Negative
- No bank-level conflict modelling within a PC; address-blind to bank/row-buffer reuse (ADR-0033 D3).
- No HBM scheduler (FR-FCFS / write-buffer / watermark drain); fixed
FIFO per PC. Bursty mixed R/W is approximated by
switch_penalty_ns(ADR-0033 D2). _txn_stateis a regular dict keyed byid(txn); in-flight state accumulates per concurrent transaction and is removed only onis_last. Adequate for current workloads.
Links
- ADR-0001 (Physical address layout — PC bit field comment)
- ADR-0015 D4 (Memory R/W fabric path — bypass response case)
- ADR-0017 D4 (Per-PE HBM partitioning — attachment to PE routers)
- ADR-0017 D8 (HBM channel mapping mode — n:1 aggregate this ADR implements)
- ADR-0017 D9 (AddressResolver —
hbm_ctrl.pe{pe_id}endpoint resolution) - ADR-0033 D1 (Modelled precisely — per-PC parallelism, switch penalty, flit-aware PC commit, first-flit overhead, chunk-loop drain)
- ADR-0033 D2 (Switch-penalty default 0 — ideal scheduler amortisation)