DOCA Comch
Where to start: This skill assumes DOCA is already installed and
the user is doing hands-on Comch work on a BlueField + host
pair 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 Comch express on this version. If the user has not
installed DOCA yet, route to
doca-setup first. If the user is
asking "is Comch even on this DOCA" because the docs they read
mention doca-comm-channel, route to
CAPABILITIES.md ## Version compatibility
for the 2.5 rename.
Example questions this skill answers well
The CLASSES of Comch 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 a Comch channel between host and DPU?" —
worked example: "server side on the DPU, client side on the
host, exchange a first control message". Answered by the
role-selection + lifecycle workflow in
TASKS.md ## configure +
CAPABILITIES.md ## Capabilities and modes
server-vs-client table.
- "How do I move bulk data over Comch with low CPU?" — worked
example: "stream a 64 KiB chunk every 100 µs from the host
driver to a DPU agent". Answered by the producer / consumer
fast-path described in
CAPABILITIES.md ## Capabilities and modes
- the channel-setup workflow in
TASKS.md ## configure
step 4, with the "slow-path vs fast-path" selection rule.
- "What is the maximum message size I can send?" — worked
example: "can I send a 4 MiB control message in one shot?".
Answered by the capability-query rule
(
doca_comch_cap_get_max_msg_size) in
CAPABILITIES.md ## Capabilities and modes
- the property-set workflow in
TASKS.md ## modify.
- "Why doesn't the DPU side see the representor?" — worked
example: "
doca_comch_server_create returns
DOCA_ERROR_NOT_PERMITTED on a freshly imaged BlueField".
Answered by the representor + permission overlay in
CAPABILITIES.md ## Safety policy
- the env-prep checklist in
TASKS.md ## configure step 1, which
routes representor-side env questions to
doca-setup.
- "Is this Comch capability on my installed DOCA version?" —
worked example: "is
doca_comch_producer in DOCA 2.6.0, or do
I still need the old slow-path API?". Answered by the
version-compatibility overlay in
CAPABILITIES.md ## Version compatibility,
which cross-links the canonical detection chain in
doca-version and adds the
Comch-specific 2.5 rename rule.
- "What does this
DOCA_ERROR_* from a Comch call mean and
which layer caused it?" — worked example: "DOCA_ERROR_AGAIN
on submitting a doca_comch_task_send via doca_task_submit". Answered by the Comch
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 Comch library — i.e., users whose code calls
doca_comch_* (directly in C/C++, or through FFI/bindings from
another language) to exchange control or data messages between a
host process and a BlueField agent over PCIe. It is not for
NVIDIA developers contributing to DOCA Comch itself.
Language scope. DOCA Comch ships as a C library with
pkg-config module name doca-comch. The shipped samples are
written in C. C and C++ consumers are the canonical case; 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 role-split, lifecycle,
capability-discovery, permission, and error-taxonomy guidance
language-neutral, and to route the agent to the public C ABI as
the authoritative surface that any wrapper will eventually call.
When to load this skill
Load this skill when the user is doing hands-on DOCA Comch work,
in any language. Concretely:
- Initializing a
doca_comch_server on the DPU side or a
doca_comch_client on the host side, on a representor or PCIe
address the host can reach.
- Configuring at least one of: a recv callback for slow-path
messages, a producer for fast-path outbound data, a consumer for
fast-path inbound data, before
doca_ctx_start().
- Reading or setting comch properties via
doca_comch_set_* and
doca_comch_cap_get_* — max message size, max number of
clients (server side), producer / consumer queue sizing.
- Establishing a connection between the two sides and reacting to
connection-state transitions via the connection callbacks
registered before start.
- Choosing between the slow-path (send-task / recv-callback,
message-oriented, lower throughput, single-call simplicity) and
the fast-path (producer / consumer, asynchronous, much
higher throughput, two-context setup).
- Debugging a
DOCA_ERROR_* returned from a Comch call (lifecycle
vs. permission vs. capability vs. would-block) and the
connection state machine across the host / DPU pair.
- Designing or extending non-C bindings (Rust, Go, Python, …) that
wrap the Comch C ABI — for the lifecycle, role-split,
permission, and capability rules the wrapper must honor.
Do not load this skill for general DOCA orientation, install
of DOCA itself, or non-Comch 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 Comch-specific
material lives in two companion files:
CAPABILITIES.md — what Comch can express on this version: the
server vs client role split, the slow-path send-task /
recv-callback surface, the producer / consumer fast-path
surface, the capability-query surface
(doca_comch_cap_get_*), the Comch error taxonomy (mapped onto
the cross-library DOCA_ERROR_* set), the observability surface
(connection state callbacks, task completion callbacks), and
the safety policy that gates representor and permission
decisions.
TASKS.md — step-by-step workflows for the six in-scope Comch
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 + BlueField pair where DOCA is already
installed at the standard location and the user has the privileges
their public install profile expects (in particular, sudo on the
DPU side to see the host representor). 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 Comch application source code, in any
language. The verified Comch source code is the shipped C
samples at
/opt/mellanox/doca/samples/doca_comch/<name>/. 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 Comch-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-comch is the source of truth.
- 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.
- For the Comch capability matrix, role split, slow-path /
fast-path surfaces, permission policy, error taxonomy,
observability, and safety policy, see CAPABILITIES.md.
- For step-by-step workflows — configure, build, modify, run,
test, debug — see TASKS.md.
Both companion files cross-link to each other,
doca-version for the canonical
version-handling rules, and
doca-public-knowledge-map
whenever the right answer is "look it up in the public docs or
the installed package layout" rather than "Comch-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. The Comch URL
slug is DOCA-Comch (DOCA 2.5+), not doca-comm-channel.
doca-setup — env preparation,
install verification, representor visibility checks, and the I
have no install yet path with the public NGC DOCA container.
This skill assumes its preconditions are satisfied.
doca-version — canonical
DOCA version-handling rules. This skill's ## Version compatibility cross-links the four-way match rule and adds the
Comch-specific 2.5 rename overlay.
doca-structured-tools-contract —
the bundle's structured-tools precedence rule (detect / prefer
/ fall back / report). The Command appendix in
TASKS.md honors this contract.
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 Comch specifics on
top.
doca-debug — the cross-cutting
debug ladder (install / version / build / link / runtime /
program / driver). Comch-specific debug (lifecycle violations,
representor visibility, slow-path vs fast-path queue-full
symptoms) overlays on top of that ladder.
1---2name: doca-comch3description: Use this skill when the user is doing hands-on DOCA Comch work on a host + BlueField pair — bringing up host ↔ DPU PCIe control-plane messaging, picking server (DPU) vs client (host) roles, choosing slow-path send-task / recv-callback vs fast-path producer / consumer, querying max-msg-size or max-clients capabilities, registering connection callbacks, or debugging DOCA_ERROR_* returns from the Comch API. Trigger even when the user does not explicitly mention "DOCA Comch" or "Comm Channel" (renamed in DOCA 2.5) — typical implicit phrasings include "send a control message from host to BlueField over PCIe", "DPU can't see the host representor", "DOCA_ERROR_NOT_PERMITTED on server_create", "DOCA_ERROR_AGAIN on task_send submit", "connect callback never fires", or "stream bulk data from a host driver to a DPU agent". Refuse and route elsewhere for installing DOCA itself, BFB / firmware bring-up, non-Comch DOCA libraries, or deploying Comch apps at scale — those belong to other skills.4license: Apache-2.05---67# DOCA Comch89**Where to start:** This skill assumes DOCA is already installed and10the user is doing **hands-on Comch work** on a BlueField + host11pair with DOCA. Open [`TASKS.md`](TASKS.md) if the user wants to12*do* something (configure / build / modify / run / test / debug);13open [`CAPABILITIES.md`](CAPABILITIES.md) when the question is14*what can Comch express* on this version. If the user has not15installed DOCA yet, route to16[`doca-setup`](../../doca-setup/SKILL.md) first. If the user is17asking *"is Comch even on this DOCA"* because the docs they read18mention `doca-comm-channel`, route to19[`CAPABILITIES.md ## Version compatibility`](CAPABILITIES.md#version-compatibility)20for the 2.5 rename.2122## Example questions this skill answers well2324The CLASSES of Comch questions this skill is built to answer, each25with one worked example. The agent should treat the *class* as the26load-bearing piece — the worked example is a single instance.2728- **"How do I bring up a Comch channel between host and DPU?"** —29 worked example: *"server side on the DPU, client side on the30 host, exchange a first control message"*. Answered by the31 role-selection + lifecycle workflow in32 [`TASKS.md ## configure`](TASKS.md#configure) +33 [`CAPABILITIES.md ## Capabilities and modes`](CAPABILITIES.md#capabilities-and-modes)34 server-vs-client table.35- **"How do I move bulk data over Comch with low CPU?"** — worked36 example: *"stream a 64 KiB chunk every 100 µs from the host37 driver to a DPU agent"*. Answered by the producer / consumer38 fast-path described in39 [`CAPABILITIES.md ## Capabilities and modes`](CAPABILITIES.md#capabilities-and-modes)40 + the channel-setup workflow in41 [`TASKS.md ## configure`](TASKS.md#configure)42 step 4, with the *"slow-path vs fast-path"* selection rule.43- **"What is the maximum message size I can send?"** — worked44 example: *"can I send a 4 MiB control message in one shot?"*.45 Answered by the capability-query rule46 (`doca_comch_cap_get_max_msg_size`) in47 [`CAPABILITIES.md ## Capabilities and modes`](CAPABILITIES.md#capabilities-and-modes)48 + the property-set workflow in49 [`TASKS.md ## modify`](TASKS.md#modify).50- **"Why doesn't the DPU side see the representor?"** — worked51 example: *"`doca_comch_server_create` returns52 `DOCA_ERROR_NOT_PERMITTED` on a freshly imaged BlueField"*.53 Answered by the representor + permission overlay in54 [`CAPABILITIES.md ## Safety policy`](CAPABILITIES.md#safety-policy)55 + the env-prep checklist in56 [`TASKS.md ## configure`](TASKS.md#configure) step 1, which57 routes representor-side env questions to58 [`doca-setup`](../../doca-setup/SKILL.md).59- **"Is this Comch capability on my installed DOCA version?"** —60 worked example: *"is `doca_comch_producer` in DOCA 2.6.0, or do61 I still need the old slow-path API?"*. Answered by the62 version-compatibility overlay in63 [`CAPABILITIES.md ## Version compatibility`](CAPABILITIES.md#version-compatibility),64 which cross-links the canonical detection chain in65 [`doca-version`](../../doca-version/SKILL.md) and adds the66 Comch-specific 2.5 rename rule.67- **"What does this `DOCA_ERROR_*` from a Comch call mean and68 which layer caused it?"** — worked example: *"`DOCA_ERROR_AGAIN`69 on submitting a `doca_comch_task_send` via `doca_task_submit`"*. Answered by the Comch70 overlay on the cross-library taxonomy in71 [`CAPABILITIES.md ## Error taxonomy`](CAPABILITIES.md#error-taxonomy)72 + the layered ladder in73 [`TASKS.md ## debug`](TASKS.md#debug) that escalates to74 [`doca-debug`](../../doca-debug/SKILL.md).7576## Audience7778This skill serves **external developers building applications that79consume the DOCA Comch library** — i.e., users whose code calls80`doca_comch_*` (directly in C/C++, or through FFI/bindings from81another language) to exchange control or data messages between a82host process and a BlueField agent over PCIe. It is *not* for83NVIDIA developers contributing to DOCA Comch itself.8485**Language scope.** DOCA Comch ships as a C library with86`pkg-config` module name `doca-comch`. The shipped samples are87written in C. C and C++ consumers are the canonical case; the88worked examples in `TASKS.md` assume that path. Other-language89consumers (Rust, Go, Python, …) consume the same `*.so` through90FFI or language-specific bindings; the skill's contribution in91that case is to keep the role-split, lifecycle,92capability-discovery, permission, and error-taxonomy guidance93language-neutral, and to route the agent to the public C ABI as94the authoritative surface that any wrapper will eventually call.9596## When to load this skill9798Load this skill when the user is doing hands-on DOCA Comch work,99in any language. Concretely:100101- Initializing a `doca_comch_server` on the DPU side or a102 `doca_comch_client` on the host side, on a representor or PCIe103 address the host can reach.104- Configuring at least one of: a recv callback for slow-path105 messages, a producer for fast-path outbound data, a consumer for106 fast-path inbound data, before `doca_ctx_start()`.107- Reading or setting comch properties via `doca_comch_set_*` and108 `doca_comch_cap_get_*` — max message size, max number of109 clients (server side), producer / consumer queue sizing.110- Establishing a connection between the two sides and reacting to111 connection-state transitions via the connection callbacks112 registered before start.113- Choosing between the **slow-path** (send-task / recv-callback,114 message-oriented, lower throughput, single-call simplicity) and115 the **fast-path** (producer / consumer, asynchronous, much116 higher throughput, two-context setup).117- Debugging a `DOCA_ERROR_*` returned from a Comch call (lifecycle118 vs. permission vs. capability vs. would-block) and the119 connection state machine across the host / DPU pair.120- Designing or extending non-C bindings (Rust, Go, Python, …) that121 wrap the Comch C ABI — for the lifecycle, role-split,122 permission, and capability rules the wrapper must honor.123124Do **not** load this skill for general DOCA orientation, install125of DOCA itself, or non-Comch library questions. For those, use126[`doca-public-knowledge-map`](../../doca-public-knowledge-map/SKILL.md).127128## What this skill provides129130This is a **thin loader**. The body keeps only the orientation131needed to pick the right next file. The substantive Comch-specific132material lives in two companion files:133134- `CAPABILITIES.md` — what Comch can express on this version: the135 server vs client role split, the slow-path send-task /136 recv-callback surface, the producer / consumer fast-path137 surface, the capability-query surface138 (`doca_comch_cap_get_*`), the Comch error taxonomy (mapped onto139 the cross-library `DOCA_ERROR_*` set), the observability surface140 (connection state callbacks, task completion callbacks), and141 the safety policy that gates representor and permission142 decisions.143- `TASKS.md` — step-by-step workflows for the six in-scope Comch144 verbs: `configure`, `build`, `modify`, `run`, `test`, `debug`.145 Plus a `Deferred task verbs` block that points out-of-scope146 questions at the right next skill.147148The skill assumes a host + BlueField pair where DOCA is already149installed at the standard location and the user has the privileges150their public install profile expects (in particular, sudo on the151DPU side to see the host representor). It does not cover installing152DOCA — that path goes through153[`doca-setup`](../../doca-setup/SKILL.md).154155## What this skill deliberately does not ship156157This skill is **agent guidance**, not a samples or templates158bundle. To keep the boundary clean, it deliberately does not159contain — and pull requests should not add:160161- **Pre-written DOCA Comch application source code, in any162 language.** The verified Comch source code is the shipped C163 samples at `/opt/mellanox/doca/samples/doca_comch/<name>/`. The164 agent's job is to route the user to those files and prescribe a165 minimum-diff modification on them via the universal166 modify-a-sample workflow in167 [`doca-programming-guide`](../../doca-programming-guide/SKILL.md),168 layered with the Comch-specific overrides in169 [`TASKS.md ## modify`](TASKS.md#modify).170- **Standalone build manifests** (`meson.build`, `CMakeLists.txt`,171 `Cargo.toml`, …) parked inside the skill. The agent constructs172 the build manifest *in the user's project directory* against173 the user's installed DOCA, where `pkg-config --modversion174 doca-comch` is the source of truth.175- **A `samples/`, `bindings/`, or `reference/` subtree** of any176 kind. A mock or incomplete artifact in this skill's tree, even177 one labeled "reference", is misleading: users will read it as178 buildable.179180## Loading order1811821. Read this `SKILL.md` first to confirm the user's question is183 in scope.1842. **For the Comch capability matrix, role split, slow-path /185 fast-path surfaces, permission policy, error taxonomy,186 observability, and safety policy, see [CAPABILITIES.md](CAPABILITIES.md).**1873. **For step-by-step workflows — configure, build, modify, run,188 test, debug — see [TASKS.md](TASKS.md).**189190Both companion files cross-link to each other,191[`doca-version`](../../doca-version/SKILL.md) for the canonical192version-handling rules, and193[`doca-public-knowledge-map`](../../doca-public-knowledge-map/SKILL.md)194whenever the right answer is "look it up in the public docs or195the installed package layout" rather than "Comch-specific196guidance".197198## Related skills199200- [`doca-public-knowledge-map`](../../doca-public-knowledge-map/SKILL.md) —201 the routing table for every public DOCA documentation source and202 the on-disk layout of an installed DOCA package. The Comch URL203 slug is `DOCA-Comch` (DOCA 2.5+), not `doca-comm-channel`.204- [`doca-setup`](../../doca-setup/SKILL.md) — env preparation,205 install verification, representor visibility checks, and the *I206 have no install yet* path with the public NGC DOCA container.207 This skill assumes its preconditions are satisfied.208- [`doca-version`](../../doca-version/SKILL.md) — canonical209 DOCA version-handling rules. This skill's `## Version210 compatibility` cross-links the four-way match rule and adds the211 Comch-specific 2.5 rename overlay.212- [`doca-structured-tools-contract`](../../doca-structured-tools-contract/SKILL.md) —213 the bundle's structured-tools precedence rule (detect / prefer214 / fall back / report). The Command appendix in215 [TASKS.md](TASKS.md) honors this contract.216- [`doca-programming-guide`](../../doca-programming-guide/SKILL.md) —217 general DOCA programming patterns shared by every library: the218 canonical `pkg-config` + meson build pattern, the universal219 modify-a-shipped-sample first-app workflow, the universal220 lifecycle, the cross-library `DOCA_ERROR_*` taxonomy, and the221 program-side debug order. This skill layers Comch specifics on222 top.223- [`doca-debug`](../../doca-debug/SKILL.md) — the cross-cutting224 debug ladder (install / version / build / link / runtime /225 program / driver). Comch-specific debug (lifecycle violations,226 representor visibility, slow-path vs fast-path queue-full227 symptoms) overlays on top of that ladder.