agentleFS
elodin-syselodin-sys/elodin/.cursor/skills/elodin-cranelift/SKILL.md

elodin-cranelift

Skill553 starsChanged 5 months agoApache-2.0View on GitHub

Work with the Cranelift JIT MLIR backend. Use when modifying libs/cranelift-mlir/, adding new StableHLO ops, debugging simulation correctness issues, running the checkpoint diagnostic tool, or working on the pointer-ABI tensor runtime.

The file

We split this skill into the rules it gives an agent

8 rules. About 0 are common, 2 are distinctive, and 6 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 6

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Always run inside nix develop.

    line 41
  2. Very specific:

    IR: add Instruction variant in src/ir.rs

    line 95
  3. Very specific:

    Parser: add arm in parse_op() in src/parser.rs

    line 96
  4. Very specific:

    Lowering (scalar): add match arm in lower_instruction() in src/lower.rs

    line 97
  5. Very specific:

    Lowering (pointer-ABI): add match arm in lower_instruction_mem() in src/lower.rs

    line 98
  6. Very specific:

    Interpreter: add a match arm in eval_instr() in src/interp.rs.

    line 100
  7. Distinctive:

    Follow "Adding a new op".

    line 140
  8. Distinctive:

    Only two matter day-to-day:

    line 144

≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Elodin Cranelift Backend

libs/cranelift-mlir/ compiles StableHLO MLIR to native code via Cranelift JIT — the default CPU backend for Elodin simulations. Deep internals live in ARCHITECTURE.md; profiling is in PERFORMANCE.md.

Default backend

Cranelift is the default (backend="cranelift" in WorldBuilder.run / .build). Override per-run:

ELODIN_BACKEND=jax-cpu python examples/<name>/main.py run   # XLA native, reference for correctness
ELODIN_BACKEND=jax-gpu python examples/<name>/main.py run   # XLA CUDA

Or in Python:

w.run(system, backend="jax-cpu")

Where things live

PathPurpose
src/ir.rsInternal IR: Module, FuncDef, Instruction variants
src/parser.rsStableHLO text → IR (Winnow parser, child contexts for while/case)
src/lower.rsIR → Cranelift JIT. Dual ABI, cross-ABI marshaling, SIMD, slot pooling
src/tensor_rt.rsRuntime: broadcast_nd, slice, transpose, reduce, gather_nd, scatter, matmul
tests/ops.rsPer-op golden tests, both ABI paths
tests/checkpoint_test.rsXLA-vs-Cranelift comparator
libs/nox-py/src/cranelift_compile.rsJAX → StableHLO, XLA reference checkpoint
libs/nox-py/src/cranelift_exec.rsCraneliftExec tick loop
libs/nox-py/src/exec.rsWorldExec enum (dispatches Cranelift vs JAX)

Everyday commands

Always run inside nix develop.

cargo test -p cranelift-mlir                    # all unit + golden tests
cargo test -p cranelift-mlir --test ops         # per-op only
cargo clippy -p cranelift-mlir -- -Dwarnings
cargo fmt -p cranelift-mlir -- --check

# Full simulation regression (requires `just install` first):
just install
ELODIN_BACKEND=cranelift bash scripts/ci/regress.sh --all                                 # every example
ELODIN_BACKEND=cranelift bash scripts/ci/regress.sh ball examples/ball/main.py            # one example
ELODIN_BACKEND=cranelift bash scripts/ci/regress.sh --update ball examples/ball/main.py   # re-baseline after verifying correctness

Baselines live in scripts/ci/baseline/; tolerances in scripts/ci/baseline/tolerances.json.

Shared Large Constants

Large stablehlo.constant dense<"0x..."> blobs over 1 MB are transparently interned by libs/cranelift-mlir:

  • Parser: src/parser.rs decodes large hex constants as raw bytes and interns them through src/const_cache.rs.
  • Cache: content-addressed by element type, byte length, and raw little-endian bytes under ${ELODIN_CACHE_DIR:-~/.cache/elodin/const-cache}.
  • IR: ConstantValue::DenseExternal is cheap to clone and carries the cached mapping handle.
  • Lowering: src/lower.rs registers each mapping with JITBuilder::symbol and lowers it through declare_data(Linkage::Import), so constants are not copied into the JIT arena.
  • Lifetime: CompiledModule must retain the Arc<CachedConst> handles for every imported constant. The JIT symbol stores raw pointers, so dropping the parsed IR module before live execution would otherwise leave dangling mmap pointers.
  • Concurrent publishing: cache writes must never replace an already-published file. Use a temp file plus no-clobber publish so simultaneous first writers converge on one inode; otherwise one process can map a now-deleted inode and lose page-cache sharing.
  • Campaigns: elodin monte-carlo run ... pins one campaign ELODIN_CACHE_DIR across all workers. Add --memory-probe only for memory-proof runs; it writes memory.json with shared-constant PSS evidence without a bespoke runner.

Relevant tests:

cargo test -p cranelift-mlir --test large_constant_cache
cargo test -p cranelift-mlir --test imported_data_arena -- --ignored --nocapture
cargo test -p cranelift-mlir large_external_constant_8d_dynamic_slice

Customer-style checkpoint repro:

ELODIN_CRANELIFT_DEBUG_DIR=/tmp/dbg \
  cargo test -p cranelift-mlir --test checkpoint_test --release verify_checkpoint -- --ignored --nocapture

# To hold two verifier processes for mmap/PSS sampling:
ELODIN_CACHE_DIR=/tmp/elodin-const-cache-proof \
ELODIN_CRANELIFT_DEBUG_DIR=/tmp/dbg \
ELODIN_CRANELIFT_CHECKPOINT_HOLD_AFTER_TICK_MS=120000 \
  cargo test -p cranelift-mlir --test checkpoint_test --release verify_checkpoint -- --ignored --nocapture

Adding a new op

  1. IR: add Instruction variant in src/ir.rs
  2. Parser: add arm in parse_op() in src/parser.rs
  3. Lowering (scalar): add match arm in lower_instruction() in src/lower.rs
  4. Lowering (pointer-ABI): add match arm in lower_instruction_mem() in src/lower.rs
  5. Runtime (if N-D): add tensor_<op>_f64 in src/tensor_rt.rs, register in TensorRtIds
  6. Interpreter: add a match arm in eval_instr() in src/interp.rs. run_mlir / run_mlir_mem execute the interpreter and require it to match the JIT; an unimplemented op logs [interp skipped] (or fails under ELODIN_CRANELIFT_INTERP_STRICT=1).
  7. Tests: golden-value tests in tests/ops.rs exercising both run_mlir and run_mlir_mem
  8. cargo test -p cranelift-mlir

The dual-ABI / SIMD / tensor-runtime design constraints each step has to satisfy are documented in ARCHITECTURE.md.

Adding a new simulation example

  1. Dump MLIR: ELODIN_BACKEND=cranelift ELODIN_CRANELIFT_DEBUG_DIR=/tmp/dbg python examples/<name>/main.py run
  2. Catalog ops: python3 libs/cranelift-mlir/scripts/catalog_ops.py /tmp/dbg/stablehlo.mlir (safe on multi-GB files — do NOT grep them)
  3. Copy the MLIR into testdata/, create an e2e test
  4. Implement any missing ops (see "Adding a new op")
  5. Regression: ELODIN_BACKEND=cranelift bash scripts/ci/regress.sh <name> examples/<name>/main.py

Debugging

Simulation produces wrong values

The tick checkpoint diagnostic tool is the workhorse. Full usage and MLIR-bisection workflow in ARCHITECTURE.md — Checkpoint Diagnostic Tool section. Quick commands:

# Capture XLA reference + Cranelift outputs for every tick input:
ELODIN_BACKEND=cranelift ELODIN_CRANELIFT_DEBUG_DIR=/tmp/ckpt \
  bash scripts/ci/regress.sh <example> examples/<example>/main.py

# Compare, per output, element-by-element:
ELODIN_CRANELIFT_DEBUG_DIR=/tmp/ckpt \
  cargo test -p cranelift-mlir --test checkpoint_test --release -- --ignored --nocapture

Once the diverging output is identified, reduce it to a minimal tests/ops.rs reproducer before fixing.

Simulation crashes (segfault / abort)

  • Try --release first: some JIT paths trip ptr::copy_nonoverlapping debug-mode UB checks.
  • Stack overflow on complex sims: the checkpoint test pins a 64 MB thread stack; mirror this if reproducing outside the test.
  • NULL pointer in JIT code is almost always a cross-ABI marshaling bug.

Compiler says "unsupported instruction" or "unsupported custom_call target"

Follow "Adding a new op".

Environment variables

Only two matter day-to-day:

  • ELODIN_BACKEND — cranelift (default), jax-cpu, jax-gpu.
  • ELODIN_CRANELIFT_DEBUG_DIR=<dir> — single flag for every diagnostic (profile probes, op-category sampling, tick waveform, instr/fold reports, inliner and slot-pool traces, MLIR dump, first-tick XLA reference checkpoint). Files land flat under <dir>. Zero overhead when unset.

Full outputs and reading guide: PERFORMANCE.md.

Further reading

  • libs/cranelift-mlir/ARCHITECTURE.md — compilation pipeline, dual ABI, SIMD (LaneRepr), JIT memory layout, tensor runtime, LAPACK via faer, gather patterns, while-loop scoping, checkpoint tool, testing strategy, opportunities.
  • libs/cranelift-mlir/PERFORMANCE.md — ELODIN_CRANELIFT_DEBUG_DIR outputs, profile report fields, diff + waveform scripts, Tracy workflow.
  • libs/cranelift-mlir/README.md — crate-level quick start.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.