DOCA RDMA
Non-negotiable: the deliverable uses DOCA RDMA, not raw verbs
When this skill is in scope, the user is asking for DOCA RDMA. The
program you produce must link libdoca_rdma and call the
doca_rdma_* API (directly in C/C++, or through a thin FFI/cgo shim
from another language). Do NOT implement the request with raw
libibverbs / librdmacm / RDMA-CM and call it done. Those move bytes
but completely bypass DOCA — which defeats the entire purpose of using
this library, loses the DOCA programming model (progress engine, task/
event lifecycle, capability discovery, portability across BlueField/
ConnectX generations), and is the single most common failure mode.
"Raw verbs is fewer lines" / "it avoids building a DOCA binding layer"
is not an acceptable reason to bypass DOCA. The correct low-friction
path for a non-C language (Go, Rust, Python, …) is not to re-bind
the whole API — it is to start from a shipped DOCA RDMA sample under
$(pkg-config --variable=prefix doca)/samples/doca_rdma/ (substitute the
module resolved on the target) and wrap its entry functions in
a thin cgo/FFI shim built with #cgo pkg-config: doca (Go) or the
equivalent. That shim is a single small file, not "a large custom
binding layer". See TASKS.md ## build Step 0 and
TASKS.md ## modify.
If pkg-config doca or the DOCA build fails, fix the build (module
name, PKG_CONFIG_PATH, sample path) — do not silently fall back to
verbs. A binary whose ldd shows no libdoca_rdma is a failed
DOCA-RDMA task, regardless of whether bytes moved.
Where to start: This skill assumes DOCA is already installed and
the user is doing hands-on RDMA work on a BlueField / ConnectX /
host with DOCA. Open TASKS.md if the user wants to do
something (configure / build / modify / run / test / debug); open
CAPABILITIES.md when the question is what can
RDMA express on this version. If the user has not installed DOCA
yet, route to doca-setup first.
Example questions this skill answers well
The CLASSES of RDMA questions this skill is built to answer, each
with one worked example. The agent should treat the class as the
load-bearing piece — the worked example is a single instance.
- "How do I bring up an RDMA context and connect two sides?" —
worked example: "set up sender + receiver with RDMA CM on a single
host for first-run testing". Answered by the lifecycle + connection
workflow in
TASKS.md ## configure +
CAPABILITIES.md ## Capabilities and modes
connection-method selection.
- "Which RDMA task type fits this data-movement pattern?" —
worked example: "one-sided write + completion via Send-with-Immediate
for a small control message". Answered by the task taxonomy in
CAPABILITIES.md ## Capabilities and modes
- the task-config workflow in
TASKS.md ## modify.
- "What mmap permissions does this task need? Do I have to export
the mmap?" — worked example: "my Read task fails with insufficient
permissions". Answered by the permission matrix in
CAPABILITIES.md ## Safety policy
- the mmap-export checklist in
TASKS.md ## test.
- "Is this RDMA capability supported on my device + transport?" —
worked example: "does this device support Atomic Compare-and-Swap
over RoCE". Answered by the capability-query rule
(
doca_rdma_cap_task_*_is_supported against a doca_devinfo) in
CAPABILITIES.md ## Capabilities and modes
- the discovery step in
TASKS.md ## configure.
- "Is this RDMA API available on my installed DOCA version?" —
worked example: "is RDMA CM in DOCA 2.6.0". Answered by the
version-compatibility section in
CAPABILITIES.md ## Version compatibility
- the version-discovery rule (
pkg-config --modversion doca)
pinned in TASKS.md ## configure.
- "What does this
DOCA_ERROR_* from an RDMA call mean and which
layer caused it?" — worked example: "DOCA_ERROR_BAD_STATE from
doca_rdma_connection_disconnect". Answered by the RDMA overlay
on the cross-library taxonomy in
CAPABILITIES.md ## Error taxonomy
- the layered ladder in
TASKS.md ## debug that escalates to
doca-debug.
Audience
This skill serves external developers building applications that
consume the DOCA RDMA library — i.e., users whose code calls
doca_rdma_* (directly in C/C++, or through FFI/bindings from
another language) to do RDMA data movement between two sides
(host↔host, host↔BlueField, DPU↔DPU, or SF↔SF on a BlueField). It
is not for NVIDIA developers contributing to DOCA RDMA itself.
Language scope. DOCA RDMA normally ships as a C library inside the
umbrella doca pkg-config module (public header doca_rdma.h, shared
object libdoca_rdma.so); split installs may expose a per-library module.
Always discover the module on the target (pkg-config --list-all | grep -i doca) rather than assuming either layout. The
shipped samples are written in C
(NVIDIA's choice). C and C++ consumers are the canonical case and
the worked examples in TASKS.md assume that path. Other-language
consumers (Rust, Go, Python, …) consume the same *.so through FFI
or language-specific bindings; the skill's contribution in that case
is to keep the lifecycle, capability-discovery, permission-matrix,
error-taxonomy, and connection-method guidance language-neutral, and
to route the agent to the public C ABI as the authoritative surface
that any wrapper will eventually call. The non-C deliverable is still
a DOCA program: a thin cgo/FFI shim over the shipped doca_rdma
sample that links libdoca_rdma (#cgo pkg-config: doca) — never a
raw-libibverbs reimplementation chosen to avoid wrapping DOCA (see the
mandate at the top of this file).
When to load this skill
Load this skill when the user is doing hands-on DOCA RDMA work, in
any language. Concretely:
- Initializing an RDMA context on a
doca_dev and configuring at
least one task type before doca_ctx_start().
- Establishing a connection — picking between RDMA CM
(
doca_rdma_connect_to_addr() / doca_rdma_start_listen_to_port()
/ doca_rdma_connection_accept()), bridge / OOB
(doca_rdma_bridge_*), or gRPC (out-of-band exchange
of doca_rdma_export() output).
- Setting permissions on
doca_mmap correctly for the chosen task
type (Read needs RDMA-read + local read-write; Write needs
RDMA-write; Atomic needs RDMA-atomic; Send needs only local
read-write).
- Reading / setting library properties via
doca_rdma_set_* and
doca_rdma_cap_get_* to size queues, list lengths, and
transport-type selection.
- Checking which RDMA task types and transport types are supported
on the active
doca_devinfo.
- Debugging a
DOCA_ERROR_* returned from an RDMA call (lifecycle
vs. permission vs. capability vs. driver-below) and the connection
state-machine transitions (doca_rdma_set_connection_state_callbacks).
- Designing or extending non-C bindings (Rust, Go, Python, …) that
wrap the RDMA C ABI — for the lifecycle, permission, and
capability rules the wrapper must honor.
Do not load this skill for general DOCA orientation, install of
DOCA itself, or non-RDMA library questions. For those, use
doca-public-knowledge-map.
What this skill provides
This is a thin loader. The body keeps only the orientation
needed to pick the right next file. The substantive RDMA-specific
material lives in two companion files:
CAPABILITIES.md — what RDMA can express on this version: the
eleven task types and their permission matrix, the three
connection methods, transport types (RC baseline and alpha-level
DC for the export/connect CPU-datapath flow — there is no UD) — note
these are the per-QP service
type controlled by doca_rdma_set_transport_type(), NOT the
link-layer (IB vs RoCE) which is inherited from the device
port configuration, the
capability-query surface (doca_rdma_cap_*), the RDMA error
taxonomy (mapped onto the cross-library DOCA_ERROR_* set), the
observability surface (per-task events, connection state callbacks),
and the safety policy that gates permission and export decisions.
TASKS.md — step-by-step workflows for the six in-scope RDMA
verbs: configure, build, modify, run, test, debug.
Plus a Deferred task verbs block that points out-of-scope
questions at the right next skill.
The skill assumes a host or BlueField where DOCA is already
installed at the standard location and the user has the privileges
their public install profile expects. It does not cover installing
DOCA — that path goes through
doca-setup.
What this skill deliberately does not ship
This skill is agent guidance, not a samples or templates bundle.
To keep the boundary clean, it deliberately does not contain — and
pull requests should not add:
- Pre-written DOCA RDMA application source code, in any
language. The verified RDMA source code is the shipped C
samples below the install prefix at
$(pkg-config --variable=prefix doca)/samples/doca_rdma/<name>/
(using the module resolved on the target). The
agent's job is to route the user to those files and prescribe a
minimum-diff modification on them via the universal
modify-a-sample workflow in
doca-programming-guide,
layered with the RDMA-specific overrides in
TASKS.md ## modify.
- Standalone build manifests (
meson.build, CMakeLists.txt,
Cargo.toml, …) parked inside the skill. The agent constructs
the build manifest in the user's project directory against the
user's installed DOCA, where pkg-config --modversion doca
is the source of truth (resolve the module per TASKS.md ## build
Step 0 — there is normally no separate doca-rdma.pc).
- A
samples/, bindings/, or reference/ subtree of any
kind. A mock or incomplete artifact in this skill's tree, even
one labeled "reference", is misleading: users will read it as
buildable.
Loading order
- Read this
SKILL.md first to confirm the user's question is in
scope.
- If the question is what RDMA can express—task taxonomy,
link-layer vs transport-type selection, connection methods,
permissions, errors, observability, or safety—read
CAPABILITIES.md.
- If the question is how to do it—configure, build, modify, run,
test, or debug—read the matching H2 in TASKS.md.
Read both companions only when the workflow depends on a
capability or safety decision; do not load both unconditionally.
Both companion files cross-link to each other and to
doca-public-knowledge-map
whenever the right answer is "look it up in the public docs or the
installed package layout" rather than "RDMA-specific guidance".
Related skills
doca-public-knowledge-map — the
routing table for every public DOCA documentation source and the
on-disk layout of an installed DOCA package. Always available
alongside this skill.
doca-setup — env preparation,
install verification, and the I have no install yet path with
the public NGC DOCA container. This skill assumes its
preconditions are satisfied.
doca-programming-guide —
general DOCA programming patterns shared by every library: the
canonical pkg-config + meson build pattern, the universal
modify-a-shipped-sample first-app workflow, the universal
lifecycle, the cross-library DOCA_ERROR_* taxonomy, and the
program-side debug order. This skill layers RDMA specifics on
top.
doca-debug — the cross-cutting
debug ladder (install / version / build / link / runtime /
program / driver). RDMA-specific debug (state-machine transitions,
permission failures, connection callbacks) overlays on top of
that ladder.
1---2name: doca-rdma3description: Use this skill when the user is doing hands-on DOCA RDMA programming on a BlueField DPU, ConnectX NIC, or DOCA host — bringing up an RDMA context on a doca_dev, picking a connection method (RDMA CM, bridge/OOB, or gRPC exchange of doca_rdma_export()), enabling one of the eleven task types (Send/Receive/Send-Imm, Read/Write/Write-Imm, Atomic CmpSwap/FetchAdd, Get/Set/Add Remote Sync Event), setting matching mmap + RDMA permissions, sizing queues and connections, querying doca_rdma_cap_*, or debugging DOCA_ERROR_* from an RDMA call. Trigger even when the user does not mention "DOCA RDMA" — typical implicit phrasings include "one-sided read returns permission denied", "completions never arrive after submit", "connection callback never fires", "how do I do atomic compare-and-swap over RoCE", or "send queue hits DOCA_ERROR_FULL under burst". Refuse and route elsewhere for general RDMA / ibverbs theory (queue pairs, MRs, RoCE vs IB), installing DOCA itself, or non-RDMA DOCA libraries.4license: Apache-2.05---67# DOCA RDMA89## Non-negotiable: the deliverable uses DOCA RDMA, not raw verbs1011When this skill is in scope, the user is asking for **DOCA RDMA**. The12program you produce **must link `libdoca_rdma` and call the13`doca_rdma_*` API** (directly in C/C++, or through a thin FFI/cgo shim14from another language). Do **NOT** implement the request with raw15`libibverbs` / `librdmacm` / RDMA-CM and call it done. Those move bytes16but completely bypass DOCA — which defeats the entire purpose of using17this library, loses the DOCA programming model (progress engine, task/18event lifecycle, capability discovery, portability across BlueField/19ConnectX generations), and is the single most common failure mode.2021"Raw verbs is fewer lines" / "it avoids building a DOCA binding layer"22is **not** an acceptable reason to bypass DOCA. The correct low-friction23path for a non-C language (Go, Rust, Python, …) is **not** to re-bind24the whole API — it is to start from a **shipped DOCA RDMA sample** under25`$(pkg-config --variable=prefix doca)/samples/doca_rdma/` (substitute the26module resolved on the target) and wrap its entry functions in27a **thin** cgo/FFI shim built with `#cgo pkg-config: doca` (Go) or the28equivalent. That shim is a single small file, not "a large custom29binding layer". See [`TASKS.md ## build`](TASKS.md#build) Step 0 and30[`TASKS.md ## modify`](TASKS.md#modify).3132If `pkg-config doca` or the DOCA build fails, **fix the build** (module33name, `PKG_CONFIG_PATH`, sample path) — do not silently fall back to34verbs. A binary whose `ldd` shows no `libdoca_rdma` is a failed35DOCA-RDMA task, regardless of whether bytes moved.3637**Where to start:** This skill assumes DOCA is already installed and38the user is doing **hands-on RDMA work** on a BlueField / ConnectX /39host with DOCA. Open [`TASKS.md`](TASKS.md) if the user wants to *do*40something (configure / build / modify / run / test / debug); open41[`CAPABILITIES.md`](CAPABILITIES.md) when the question is *what can42RDMA express* on this version. If the user has not installed DOCA43yet, route to [`doca-setup`](../../doca-setup/SKILL.md) first.4445## Example questions this skill answers well4647The CLASSES of RDMA questions this skill is built to answer, each48with one worked example. The agent should treat the *class* as the49load-bearing piece — the worked example is a single instance.5051- **"How do I bring up an RDMA context and connect two sides?"** —52 worked example: *"set up sender + receiver with RDMA CM on a single53 host for first-run testing"*. Answered by the lifecycle + connection54 workflow in [`TASKS.md ## configure`](TASKS.md#configure) +55 [`CAPABILITIES.md ## Capabilities and modes`](CAPABILITIES.md#capabilities-and-modes)56 connection-method selection.57- **"Which RDMA task type fits this data-movement pattern?"** —58 worked example: *"one-sided write + completion via Send-with-Immediate59 for a small control message"*. Answered by the task taxonomy in60 [`CAPABILITIES.md ## Capabilities and modes`](CAPABILITIES.md#capabilities-and-modes)61 + the task-config workflow in62 [`TASKS.md ## modify`](TASKS.md#modify).63- **"What mmap permissions does this task need? Do I have to export64 the mmap?"** — worked example: *"my Read task fails with insufficient65 permissions"*. Answered by the permission matrix in66 [`CAPABILITIES.md ## Safety policy`](CAPABILITIES.md#safety-policy)67 + the mmap-export checklist in68 [`TASKS.md ## test`](TASKS.md#test).69- **"Is this RDMA capability supported on my device + transport?"** —70 worked example: *"does this device support Atomic Compare-and-Swap71 over RoCE"*. Answered by the capability-query rule72 (`doca_rdma_cap_task_*_is_supported` against a `doca_devinfo`) in73 [`CAPABILITIES.md ## Capabilities and modes`](CAPABILITIES.md#capabilities-and-modes)74 + the discovery step in75 [`TASKS.md ## configure`](TASKS.md#configure).76- **"Is this RDMA API available on my installed DOCA version?"** —77 worked example: *"is RDMA CM in DOCA 2.6.0"*. Answered by the78 version-compatibility section in79 [`CAPABILITIES.md ## Version compatibility`](CAPABILITIES.md#version-compatibility)80 + the version-discovery rule (`pkg-config --modversion doca`)81 pinned in [`TASKS.md ## configure`](TASKS.md#configure).82- **"What does this `DOCA_ERROR_*` from an RDMA call mean and which83 layer caused it?"** — worked example: *"`DOCA_ERROR_BAD_STATE` from84 `doca_rdma_connection_disconnect`"*. Answered by the RDMA overlay85 on the cross-library taxonomy in86 [`CAPABILITIES.md ## Error taxonomy`](CAPABILITIES.md#error-taxonomy)87 + the layered ladder in88 [`TASKS.md ## debug`](TASKS.md#debug) that escalates to89 [`doca-debug`](../../doca-debug/SKILL.md).9091## Audience9293This skill serves **external developers building applications that94consume the DOCA RDMA library** — i.e., users whose code calls95`doca_rdma_*` (directly in C/C++, or through FFI/bindings from96another language) to do RDMA data movement between two sides97(host↔host, host↔BlueField, DPU↔DPU, or SF↔SF on a BlueField). It98is *not* for NVIDIA developers contributing to DOCA RDMA itself.99100**Language scope.** DOCA RDMA normally ships as a C library *inside the101umbrella `doca` pkg-config module* (public header `doca_rdma.h`, shared102object `libdoca_rdma.so`); split installs may expose a per-library module.103Always discover the module on the target (`pkg-config --list-all |104grep -i doca`) rather than assuming either layout. The105shipped samples are written in C106(NVIDIA's choice). C and C++ consumers are the canonical case and107the worked examples in `TASKS.md` assume that path. Other-language108consumers (Rust, Go, Python, …) consume the same `*.so` through FFI109or language-specific bindings; the skill's contribution in that case110is to keep the lifecycle, capability-discovery, permission-matrix,111error-taxonomy, and connection-method guidance language-neutral, and112to route the agent to the public C ABI as the authoritative surface113that any wrapper will eventually call. **The non-C deliverable is still114a DOCA program**: a thin cgo/FFI shim over the shipped `doca_rdma`115sample that links `libdoca_rdma` (`#cgo pkg-config: doca`) — never a116raw-libibverbs reimplementation chosen to avoid wrapping DOCA (see the117mandate at the top of this file).118119## When to load this skill120121Load this skill when the user is doing hands-on DOCA RDMA work, in122any language. Concretely:123124- Initializing an RDMA context on a `doca_dev` and configuring at125 least one task type before `doca_ctx_start()`.126- Establishing a connection — picking between RDMA CM127 (`doca_rdma_connect_to_addr()` / `doca_rdma_start_listen_to_port()`128 / `doca_rdma_connection_accept()`), bridge / OOB129 (`doca_rdma_bridge_*`), or gRPC (out-of-band exchange130 of `doca_rdma_export()` output).131- Setting permissions on `doca_mmap` correctly for the chosen task132 type (Read needs RDMA-read + local read-write; Write needs133 RDMA-write; Atomic needs RDMA-atomic; Send needs only local134 read-write).135- Reading / setting library properties via `doca_rdma_set_*` and136 `doca_rdma_cap_get_*` to size queues, list lengths, and137 transport-type selection.138- Checking which RDMA task types and transport types are supported139 on the active `doca_devinfo`.140- Debugging a `DOCA_ERROR_*` returned from an RDMA call (lifecycle141 vs. permission vs. capability vs. driver-below) and the connection142 state-machine transitions (`doca_rdma_set_connection_state_callbacks`).143- Designing or extending non-C bindings (Rust, Go, Python, …) that144 wrap the RDMA C ABI — for the lifecycle, permission, and145 capability rules the wrapper must honor.146147Do **not** load this skill for general DOCA orientation, install of148DOCA itself, or non-RDMA library questions. For those, use149[`doca-public-knowledge-map`](../../doca-public-knowledge-map/SKILL.md).150151## What this skill provides152153This is a **thin loader**. The body keeps only the orientation154needed to pick the right next file. The substantive RDMA-specific155material lives in two companion files:156157- `CAPABILITIES.md` — what RDMA can express on this version: the158 eleven task types and their permission matrix, the three159 connection methods, transport types (RC baseline and alpha-level160 DC for the export/connect CPU-datapath flow — there is no UD) — note161 these are the per-QP service162 type controlled by `doca_rdma_set_transport_type()`, NOT the163 link-layer (IB vs RoCE) which is inherited from the device164 port configuration, the165 capability-query surface (`doca_rdma_cap_*`), the RDMA error166 taxonomy (mapped onto the cross-library `DOCA_ERROR_*` set), the167 observability surface (per-task events, connection state callbacks),168 and the safety policy that gates permission and export decisions.169- `TASKS.md` — step-by-step workflows for the six in-scope RDMA170 verbs: `configure`, `build`, `modify`, `run`, `test`, `debug`.171 Plus a `Deferred task verbs` block that points out-of-scope172 questions at the right next skill.173174The skill assumes a host or BlueField where DOCA is already175installed at the standard location and the user has the privileges176their public install profile expects. It does not cover installing177DOCA — that path goes through178[`doca-setup`](../../doca-setup/SKILL.md).179180## What this skill deliberately does not ship181182This skill is **agent guidance**, not a samples or templates bundle.183To keep the boundary clean, it deliberately does not contain — and184pull requests should not add:185186- **Pre-written DOCA RDMA application source code, in any187 language.** The verified RDMA source code is the shipped C188 samples below the install prefix at189 `$(pkg-config --variable=prefix doca)/samples/doca_rdma/<name>/`190 (using the module resolved on the target). The191 agent's job is to route the user to those files and prescribe a192 minimum-diff modification on them via the universal193 modify-a-sample workflow in194 [`doca-programming-guide`](../../doca-programming-guide/SKILL.md),195 layered with the RDMA-specific overrides in196 [`TASKS.md ## modify`](TASKS.md#modify).197- **Standalone build manifests** (`meson.build`, `CMakeLists.txt`,198 `Cargo.toml`, …) parked inside the skill. The agent constructs199 the build manifest *in the user's project directory* against the200 user's installed DOCA, where `pkg-config --modversion doca`201 is the source of truth (resolve the module per `TASKS.md ## build`202 Step 0 — there is normally no separate `doca-rdma.pc`).203- **A `samples/`, `bindings/`, or `reference/` subtree** of any204 kind. A mock or incomplete artifact in this skill's tree, even205 one labeled "reference", is misleading: users will read it as206 buildable.207208## Loading order2092101. Read this `SKILL.md` first to confirm the user's question is in211 scope.2122. If the question is *what RDMA can express*—task taxonomy,213 link-layer vs transport-type selection, connection methods,214 permissions, errors, observability, or safety—read215 [CAPABILITIES.md](CAPABILITIES.md).2163. If the question is *how to do it*—configure, build, modify, run,217 test, or debug—read the matching H2 in [TASKS.md](TASKS.md).218 Read both companions only when the workflow depends on a219 capability or safety decision; do not load both unconditionally.220221Both companion files cross-link to each other and to222[`doca-public-knowledge-map`](../../doca-public-knowledge-map/SKILL.md)223whenever the right answer is "look it up in the public docs or the224installed package layout" rather than "RDMA-specific guidance".225226## Related skills227228- [`doca-public-knowledge-map`](../../doca-public-knowledge-map/SKILL.md) — the229 routing table for every public DOCA documentation source and the230 on-disk layout of an installed DOCA package. Always available231 alongside this skill.232- [`doca-setup`](../../doca-setup/SKILL.md) — env preparation,233 install verification, and the *I have no install yet* path with234 the public NGC DOCA container. This skill assumes its235 preconditions are satisfied.236- [`doca-programming-guide`](../../doca-programming-guide/SKILL.md) —237 general DOCA programming patterns shared by every library: the238 canonical `pkg-config` + meson build pattern, the universal239 modify-a-shipped-sample first-app workflow, the universal240 lifecycle, the cross-library `DOCA_ERROR_*` taxonomy, and the241 program-side debug order. This skill layers RDMA specifics on242 top.243- [`doca-debug`](../../doca-debug/SKILL.md) — the cross-cutting244 debug ladder (install / version / build / link / runtime /245 program / driver). RDMA-specific debug (state-machine transitions,246 permission failures, connection callbacks) overlays on top of247 that ladder.248249