Skip to main content

Module system

Module system 

Source
Expand description

One reading of the machine, and the defaults derived from it.

Every number the release proposes — how many stores index at once, how many threads a writer gets, how much memory an index may hold — comes from read and [derive]. There is one reading and one derivation so the admission queue, the portal’s Index page and the CLI cannot disagree about the machine they are all running on, and so a user shown a number can be told the sentence that produced it.

Structs§

Derivation
One derived default and the sentence that produced it.
Derived
The three defaults the release proposes.
Machine
What the platform says about this machine.

Constants§

PER_RUN_PEAK_MB
Peak resident memory one indexing run costs, in megabytes.
RESERVE_MB
Memory the derivation refuses to spend, in megabytes.

Functions§

cpu_name
This machine’s processor, by name, for the CPU lane’s row on the Machine limits card. A generic answer where the platform will not say.
derive
Propose the three defaults for this machine, with the sentence behind each.
read
Read this machine, per platform. Never panics; never reports zero cores.
threads_for
The threads-per-writer derivation for a given number of runs at once.