FAQ and troubleshooting

Platform spec article

FAQ and troubleshooting

Back to Lowering contract ◎ Open feature in platform map

Spec standingStandard

Owner

Piotr Mikstacki pmikstacki@cybernomad.it

Submitter

Piotr Mikstacki pmikstacki@cybernomad.it

Current document

ADRs (3)

1. 0001-feature-hub-authority Feature hub authority Accepted

   This feature hub owns normative MUST/SHOULD contract text for Lowering contract.

   Context

   Sibling articles under this feature previously restated requirements in inconsistent forms.

   Decision

   This feature hub owns normative MUST/SHOULD contract text. Sibling articles must not redefine hub requirements and should link here for authority.

   Consequences

   Contract changes start on the hub or in linked ADRs, then propagate to articles and implementation anchors.

   Verification anchors

   • site/website/src/content/docs/platform-spec/compiler/codegen-and-ir/lowering-contract/index.mdx
   • article bundle under the same feature directory.

   Open full ADR page

2. 0002-spec-over-implementation-notes Specification over implementation notes Accepted

   Platform-spec text supersedes informal crate comments for Lowering contract.

   Context

   Implementation crates accumulated informal notes that diverged from published contracts.

   Decision

   Normative platform-spec prose and ADRs under this feature supersede informal comments in implementation crates until explicitly migrated into spec text.

   Consequences

   Engineers file spec/ADR updates when behavior changes; crate comments are non-authoritative for conformance arguments.

   Verification anchors

   • compiler/crates/beskid_codegen
   • compiler/crates/beskid_codegen
   • compiler/crates/beskid_engine/src/jit_module.rs

   Open full ADR page

3. 0003-cranelift-lowering-single-entry Cranelift lowering via lower_source Accepted

   Lowering was split across experimental paths.

   Context

   Lowering was split across experimental paths.

   Decision

   beskid_codegen::lower_source is the single lowering entry producing CodegenArtifact consumed by JitModule.

   Consequences

   Experimental IR dumps must not bypass this entry in release builds.

   Verification anchors

   • compiler/crates/beskid_codegen
   • compiler/crates/beskid_engine/src/jit_module.rs.

   Open full ADR page

Articles

• Contracts and edge cases Normative guarantees and known edge cases for `Lowering contract`. article Standard
• Design model Conceptual model for `Lowering contract` and its subsystem boundaries. article Standard
• Examples Practical examples that demonstrate `Lowering contract` behavior. article Standard
• FAQ and troubleshooting Common questions and debugging guidance for `Lowering contract`. article Standard
• Flow and algorithm End-to-end control flow and major algorithmic steps for `Lowering contract`. article Standard
• Verification and traceability How `Lowering contract` requirements map to tests and implementation anchors. article Standard

History

0 revisions (git unavailable at build; counts may be empty)

Open full history on GitHub

No commits recorded for this path.

Completeness

OKfeature · 2 SpecSection(s) · 1 H2 heading(s)

Section id	Required	Found
what-this-feature-specifies	yes	yes
implementation-anchors	yes	yes

Full tree: run pnpm verify:platform-spec-layout (writes src/generated/platform-spec-layout-report.json).

Related spec docs

• Area
  Codegen and IR

  Parent area

• Feature
  Stage ordering and artifacts

  Pipeline ordering that lowering must follow

• Domain
  Execution

  Lowered artifacts are consumed by execution backends

• Feature
  Lowering contract

  Parent feature hub

Why did a change pass locally but fail in CI?

Most often, one crate boundary changed but the corresponding fixture or downstream consumer was not updated. Re-run the nearest conformance suite and inspect cross-crate handoff points.

Where should I start debugging?

1. Confirm the target requirement in this feature hub.
2. Step through beskid_codegen::lower_source` in `compiler/crates/beskid_codegen and CodegenArtifact` construction in `compiler/crates/beskid_codegen.
3. Validate consumer behavior at JitModule` consumption in `compiler/crates/beskid_engine/src/jit_module.rs.
4. Reproduce with Runtime execution coverage in compiler/crates/beskid_tests/src/runtime/jit.rs“.

How do I add a new rule safely?

Document the new contract in the relevant article, update implementation in the owning crate, and add a fixture proving both happy-path and failure-path behavior.