Skip to main content

Module results

Module results 

Source
Expand description

The result document: a versioned record of one benchmark run, with the provenance that makes it comparable (commit, dirty state, build profile, platform, registry fingerprint, profile) and, per target, the statistics of each cache mode measured. Local runs are written under the checkout’s local half; the accepted baseline is a tracked file of the same shape, minus the machine-local fields, promoted explicitly.

Structs§

BenchmarkResult
One target’s measurement.
Provenance
The provenance a run carries.
ResultDocument
One run.

Enums§

CacheMode
How the cache stood when the samples were taken.

Constants§

LOCAL_DIR
Where local results go, relative to the checkout-local half.
RESULT_SCHEMA
The schema of a result document.

Functions§

host_fingerprint
The CPU brand string and the logical core count, <brand>/<cores>; the brand alone when the count is unknown, the os and arch when neither is (an unidentified host still gets a stable, if coarse, name, and two of them never compare as equal only when the string is empty, which this function does not return).
load_average
The host’s 1-minute load average, from getloadavg(3); None where the platform has none or the call fails.
write_atomic
Write a file through a temporary neighbour and a rename, so that a reader never sees half a file.