ADR housekeeping: category prefixes, lifecycle folders, retroactive 0034-0037

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>
This commit is contained in:
2026-05-20 01:15:55 -07:00
parent 22fd0d2b9d
commit 687c98086d
97 changed files with 3286 additions and 3766 deletions
+11 -14
View File
@@ -1,4 +1,4 @@
"""Tests for CUBE NOC Explicit Router Mesh (ADR-0019).
"""Tests for CUBE NOC Explicit Router Mesh (ADR-0017).
Key changes verified:
- Explicit router nodes per cube from cube_mesh.yaml (6×6 grid)
@@ -125,14 +125,14 @@ def test_mesh_file_pe_corner_positions():
def test_mesh_file_no_xbar_section():
"""mesh output must not contain xbar section (ADR-0019 D2)."""
"""mesh output must not contain xbar section (ADR-0017 D1)."""
_graph()
mesh = yaml.safe_load(MESH_PATH.read_text())
assert "xbar" not in mesh, "xbar section should be removed from cube_mesh.yaml"
def test_mesh_file_pe_hbm_attached():
"""PE routers must have pe{idx}.hbm in attach list (ADR-0019 D1)."""
"""PE routers must have pe{idx}.hbm in attach list (ADR-0017 D4)."""
_graph()
mesh = yaml.safe_load(MESH_PATH.read_text())
for rid, rdata in mesh["routers"].items():
@@ -235,7 +235,7 @@ def test_mesh_ucie_all_four_directions():
# ══════════════════════════════════════════════════════════════════
# 2. Topology Graph: Explicit Router Mesh (ADR-0019)
# 2. Topology Graph: Explicit Router Mesh (ADR-0017)
# ══════════════════════════════════════════════════════════════════
@@ -247,7 +247,7 @@ def test_router_nodes_exist():
def test_no_xbar_or_bridge_nodes():
"""xbar/bridge nodes must not exist (ADR-0019 D2)."""
"""xbar/bridge nodes must not exist (ADR-0017 D1)."""
graph = _graph()
bad = [n for n in graph.nodes if "xbar" in n or "bridge" in n]
assert len(bad) == 0, f"Old xbar/bridge nodes found: {bad[:5]}"
@@ -260,11 +260,10 @@ def test_no_single_noc_node():
def test_per_pe_hbm_ctrl_nodes():
"""Each cube has 8 per-PE HBM CTRL instances (ADR-0019 D1).
"""Each cube has 8 per-PE HBM CTRL instances (ADR-0017 D4).
Restored from over-consolidation in commit 5917b34. The legacy
single ``sip0.cube0.hbm_ctrl`` is gone; each PE owns its own
``hbm_ctrl.pe{X}`` reachable through that PE's attaching router.
Each PE owns its own ``hbm_ctrl.pe{X}`` reachable through that PE's
attaching router. No cube-wide single ``hbm_ctrl`` node exists.
"""
graph = _graph()
for pe in range(8):
@@ -272,7 +271,7 @@ def test_per_pe_hbm_ctrl_nodes():
# Legacy single hbm_ctrl must not exist
legacy_id = "sip0.cube0.hbm_ctrl"
assert legacy_id not in graph.nodes, (
f"legacy {legacy_id} must be removed (per-PE partitioning, ADR-0019 D1)"
f"legacy {legacy_id} must not exist (per-PE partitioning, ADR-0017 D4)"
)
@@ -297,9 +296,7 @@ def test_pe_dma_connects_to_router():
def test_each_hbm_ctrl_connects_only_to_owning_router():
"""Each ``hbm_ctrl.pe{X}`` must have exactly one router edge
(router_to_hbm + hbm_to_router) to its owning PE's attaching
router (ADR-0019 D4). Replaces a prior test that asserted the
single hbm_ctrl was connected to all routers — that asserted the
spec-violating consolidation introduced in commit 5917b34.
router (ADR-0017 D7).
"""
graph = _graph()
pe_router = {0: "r0c0", 1: "r0c1", 2: "r1c4", 3: "r1c5",
@@ -513,7 +510,7 @@ def test_null_routers_excluded():
# ══════════════════════════════════════════════════════════════════
# 7. Router Mesh Latency (ADR-0019)
# 7. Router Mesh Latency (ADR-0017)
# ══════════════════════════════════════════════════════════════════