Brummel
832375f2ac
All 176 files in the four accumulating directories now use a zero-padded 4-digit counter prefix that reflects creation order (`NNNN-slug.md`). The counter is assigned per directory in strict git-log creation order; ties broken alphabetically by original name. The old `YYYY-MM-DD-` prefix on docs/specs/ and docs/plans/ files is dropped — the date is recoverable from git log and the counter carries the ordering. A file's counter is stable for the life of the file: never reassigned, never reused, never compacted. Deleted files retire their counter; subsequent files do not fill the gap. This is the property that lets cross-references stay literal — refs use the full filename including the counter (`design/contracts/0007-honesty-rule.md`) so they grep cleanly and resolve directly without a glob step. 313 cross-references updated across .md/.rs/.toml/.c/.json files (test pins, include_str! paths, design-INDEX entries, baseline notes, runtime C comments, inter-contract markdown links incl. bare basename and `../models/foo.md` forms). CLAUDE.md gets a new "File-naming convention" section spelling out the rule and rationale. skills/brainstorm/SKILL.md and skills/planner/SKILL.md updated so new spec/plan creation produces counter-prefixed names from the start. The full test suite (cargo test --workspace) passes.
81 lines
4.4 KiB
Markdown
81 lines
4.4 KiB
Markdown
# Pipeline and CLI
|
|
|
|
## Pipeline
|
|
|
|
```
|
|
.ail.json ─┐
|
|
├─ load + validate schema
|
|
├─ resolve names + assign hashes
|
|
├─ desugar (AST → AST)
|
|
├─ typecheck (HM, effect rows; mode-strict per the memory model)
|
|
├─ lift_letrecs (post-typecheck AST → AST)
|
|
├─ lower to MIR (SSA-like, named SSA values)
|
|
├─ emit LLVM IR (.ll)
|
|
└─ clang -O2 *.ll -o binary
|
|
--alloc=rc → emits inc/dec (@ailang_rc_inc / _dec; canonical, default)
|
|
--alloc=bump → links bump-floor (@bump_malloc; raw-alloc bench-floor)
|
|
```
|
|
|
|
Two allocator backends share the same MIR. `--alloc=rc` is the
|
|
canonical backend committed to in the
|
|
[memory model](../contracts/0008-memory-model.md) and the CLI default;
|
|
the typechecker enforces `(own)` / `(borrow)` modes, codegen emits
|
|
`ailang_rc_inc` / `_dec` calls at the points dictated by linearity,
|
|
and `Term::Clone` / `Term::ReuseAs` materialise into actual rc-bumps
|
|
and in-place rewrites respectively. `--alloc=bump` selects the
|
|
raw-alloc bench-floor (`runtime/bump.c`, no free, leak-only) and is
|
|
used by `bench/run.sh` to measure RC overhead against the
|
|
structurally cheapest allocator — it is not a production target.
|
|
|
|
The **desugar** pass
|
|
([`ailang-core::desugar::desugar_module`](../../crates/ailang-core/src/desugar.rs))
|
|
runs before typecheck and codegen in every entry point of
|
|
`ailang-check` and `ailang-codegen`. It is a pure AST → AST rewriter — currently
|
|
only flattens nested constructor patterns, but is the chosen
|
|
home for any future surface-smoothing rewrites that should not bloat
|
|
the core AST or the backends. **Critical invariant:** `CheckedModule.symbols`
|
|
in the `check` entry point continues to hash from the *original*
|
|
on-disk module, not the desugared one, so `ail diff` and `ail manifest`
|
|
report identities that match the canonical JSON the user is editing.
|
|
|
|
The **lift_letrecs** pass (`ailang-check::lift_letrecs`)
|
|
runs **after** typecheck and **before** codegen, but only on the
|
|
`build` / `run` paths — the `check` subcommand stops at typecheck
|
|
and never sees a lifted module. It eliminates every `Term::LetRec`
|
|
that the desugar pass left in place (the case where at least one
|
|
capture is `Term::Let`-bound, so its type is only knowable after
|
|
inference). The output is a module with synthetic `<hint>$lr_N`
|
|
top-level fns appended, ready for codegen. Synthetic FnDefs added
|
|
by this pass do **not** appear in `CheckedModule.symbols` — same
|
|
invariant as the desugar-pass lifts.
|
|
|
|
## CLI
|
|
|
|
```
|
|
ail check <module.ail.json> — loads, validates, typechecks
|
|
ail manifest <module.ail.json> — table: name :: type !effects [hash]
|
|
ail describe <module> <name> — detail of a definition (form-A body)
|
|
ail render <module.ail.json> — JSON-AST → form-A text (exact inverse of `parse`)
|
|
ail parse <module.ail> — form-A text → canonical JSON-AST
|
|
ail prose <module.ail.json> — JSON-AST → form-B (lossy human prose, no parser)
|
|
ail merge-prose <m.ail.json> <m.prose.txt>
|
|
— compose the LLM-mediator prompt for the prose round-trip
|
|
ail deps <module.ail.json> — list cross-module references
|
|
ail diff <a.ail.json> <b.ail.json> — content-addressed def-level diff
|
|
ail workspace <entry.ail.json> — list all modules transitively reachable from entry
|
|
(`--json` for machine output;
|
|
`manifest --workspace` and `diff --workspace`
|
|
extend single-module subcommands to workspaces)
|
|
ail builtins — list built-in fns and effect ops
|
|
ail emit-ir <module> [--emit=staticlib] — writes .ll (staticlib: a main-free kernel's IR, no @main)
|
|
ail build <module> [--emit=staticlib] — full pipeline → binary (staticlib: lib<entry>.a + libailang_rt.a)
|
|
ail run <module> — build + execute (tempdir), passthrough exit code
|
|
```
|
|
|
|
The text projections the CLI moves between are documented in
|
|
[authoring surface](../contracts/0001-authoring-surface.md) (Form-A,
|
|
round-trippable) and [prose projection](0006-prose-projection.md)
|
|
(Form-B, lossy, no parser); `ail build --emit=staticlib` produces
|
|
the layout fixed in [embedding ABI](../contracts/0003-embedding-abi.md)
|
|
plus [frozen value layout](../contracts/0006-frozen-value-layout.md).
|