Fastpath Benchmark Catalog

This section documents benchmark definitions available from the Fastpath benchmark library. Each benchmark has its own generated page named from the suite/name benchmark id, with / replaced by -. For example, lmbench/lat-mem-rd is documented in lmbench-lat-mem-rd.rst.

This page documents the benchmark catalog. For the plan schema and examples showing how benchmark fragments are included from plans, see Plan Schema.

The fastpath benchmark command inspects benchmark definitions from the configured Fastpath benchmark libraries. It is separate from fastpath result commands: fastpath benchmark describes benchmark definitions and documentation metadata, while fastpath result reads data that has already been collected into a resultstore.

Listing Benchmarks

Use fastpath benchmark list to list the benchmarks available from the configured benchmark libraries:

fastpath benchmark list

The output shows each benchmark id in suite/name form, a summary when documentation metadata is available, and the rendered documentation URL.

Use --id to filter the list by exact id or shell-style glob:

fastpath benchmark list --id "lmbench/*"

Rendering Benchmark Documentation

Use fastpath benchmark show to render the RST documentation for one benchmark id:

fastpath benchmark show --id lmbench/lat-mem-rd

To write the RST output to a file, use --output with any target RST file name:

fastpath benchmark show \
  --id lmbench/lat-mem-rd \
  --output lat-mem-rd-details.rst

The benchmark catalog below contains one page for each benchmark id available from the Fastpath benchmark library.

Benchmark Page Layout

Each benchmark page starts with a short summary and a benchmark profile:

  • Type describes whether the benchmark is a focused micro benchmark or a broader macro workload.

  • Kernel subsystem names the Linux kernel areas most directly exercised by the benchmark, or the kernel areas most likely to influence the workload when the signal is indirect.

  • Coverage explains whether the benchmark directly measures the named kernel behavior or infers sensitivity through a larger workload.

  • Topology describes the Fastpath role layout required to run the benchmark. Single role: executer is the default Fastpath role used when a benchmark does not declare explicit roles in its YAML definition.

The remaining sections describe the benchmark overview, Fastpath parameters, result-class naming, and the source benchmark metadata used to generate the page.