Skip to content
How to Read This Guide

How to Read This Guide

Every chapter from Queue Pair Management onward follows the same template, and draws on the same five color-coded callouts wherever one earns its place. Both are named here once, so you recognize them by design from the first chapter rather than by repetition several chapters in.

The chapter template

Every chapter outside the Overview part — not the chapters you’ve been reading here, including this one — follows the same core shape, in this order:

  • Overview. One paragraph stating what this block does and why it exists, before any mechanism is described.
  • Locator. The master RNIC block diagram, with this chapter’s block highlighted and everything else dimmed. It’s both a “you are here” and the chapter’s hero image, the same drawing every time, never a new diagram. Here it is whole, every block clickable to the chapter that owns it:
rnic.io -- RNIC Architecture, Master Block DiagramEvery block this book covers. Each chapter opens with this same drawing, one block highlighted, the rest dimmed.Host MemoryDescriptor RingsWQE Fetch /TX SchedulerTX Packet BuildBTH+RETH/AETH, ICRCwireoutQP CacheQP TableMR / Key TableKey CacheReplay Buffer /Retry TimerRate LimiterCNP Generationreceive side, on ECN markfour instances of the sametable + working-set + eviction shapeDMA EngineAddress translation,scatter-gather walkSystem IOMMU / SMMUoutside the RNIC, if presentwireinRX Parser /ReassemblyRX PSN CheckCQE GenCQ StorageHost:Event / Interruptwhich QPrate checkgateslkey/rkeyresolved heregathered payloadunacked copy heldsend completion (if signaled)dest QPfrom BTHack matchingaccepted -> DMA writeresponse duereceive completionECN mark seen
  • Block diagram. A second diagram, zoomed to just this stage or structure, replacing the locator’s whole-chip context with actual internal detail.
  • Deep walkthrough. What a field or signal is, where in the pipeline it’s checked, what failure mode it produces when it’s wrong, and what happens next — retried, retracted, or aborted, at what scope. Where another chapter owns the next step, this section names that chapter and stops, rather than re-explaining what it already covers.

This is a shape to expect, not a checklist every chapter is forced through – a chapter that has nothing real to say in a given section skips it rather than filling it with restated prose or an invented number to look complete. Once you’ve read a few chapters, you’ll recognize the shape of the rest, even where one of them departs from it for a real reason.

Queue Pair Management’s opening chapter, QP Context, is where that shape starts, and where this book’s real depth begins.

The five callout colors

Every chapter draws on the same five color-coded boxes, each one a different kind of aside from the main text. Not every chapter uses all five, or any of them — a box only appears where it earns its place.

Concept

Blue. A definition or idea worth carrying forward verbatim – the kind of statement you’d want to remember exactly, not just in spirit.

Why

Green. Design rationale: why a structure got built this way, and what got traded off to get there. This is the one place the book allows itself a narrative voice; everything outside these boxes stays datasheet-plain.

Analogy

Amber. A CPU or SoC-side comparison, pulled out of the main text into its own box – useful for building intuition, never load-bearing for the actual RNIC-side claim being made.

Gotcha

Red. A trap, a common misreading, or a place this book’s own reasoning could mislead you if you generalized it past where it actually applies.

Food for Thought

Purple. An open question, usually one this book can’t fully answer from public sources – worth sitting with rather than skimming past.

Last updated on