bcd41810f4
Reader-facing prose and rustdoc carried opaque shorthand like
"Decision 10", "clause-5", "mq.1", "ct.1", "eob.1", "rpe.1",
"post-mq.3", and "Iter 22b.1:" with no in-repo definition the reader
could follow. This commit replaces every such occurrence in the
durable tier the reader is most likely to land on (design/ ledger +
source //! module headers + the central /// public-item rustdoc) with
an inline content phrase plus, where applicable, a Markdown link to
the file that defines the referenced concept.
design/ ledger — 16 files:
Definition-site headings demoted from "Decision N: <title>" to
"<title>": authoring-surface, tail-calls, memory-model section in
rc-uniqueness.md, dual-allocator section, typeclass design,
effects "pure core + algebraic effects".
Cross-reference sites: "Decision 1" -> canonical-schema principle
(data-model); "Decision 3/4" -> effects + scope-boundaries; "Decision
6" -> authoring-surface; "Decision 8" -> tail-calls; "Decision 9" ->
rc-uniqueness (dual-allocator); "Decision 10" -> memory-model;
"Decision 11" -> typeclasses (model). "clause-5" -> body-link
durability gate. "clause-3" (in language-constraints) ->
bug-class-reintroduction discriminator. "mq.1/2/3", "ct.1/4",
"eob.1", "rpe.1" -> the canonical-form rule / the type-driven
dispatch / the Str carve-out / etc. "post-mq.3" -> "type-driven".
design/contracts/feature-acceptance.md: file-local "clauses 1/2/3"
-> "criteria 1/2/3" (sprachliche Kohärenz mit der File-Überschrift
"Feature-acceptance criterion"); "the clause-3 mechanism" -> "the
bug-class-reintroduction discriminator".
Source //! module headers — 24 files:
Stripped "Iter X.Y:" prefixes and "(Decision N)" / "(mq.X)" tags
from spec_drift, uniqueness, reuse_shape, migrate_canonical_types,
typeclass_22b{2,3,c}, suppress_filter, lift, mono, linearity,
diagnostic, method_dispatch_pin, method_collision_pin,
no_per_type_print_ops, mq3_multi_class_e2e, print_mono_body_shape,
print_no_leak_pin, cli_diag_human_workspace_load_error,
ct1_check_cli, prose snapshot, unbound_in_instance_method_pin,
mono_xmod_ctor_pattern, desugar.
Central /// public-item rustdoc:
ast.rs (full sweep — every "Iter X" + "Decision N" prefix
reformulated; mode/Type::Fn rustdoc now points at memory-model.md;
Constraint / SuperclassRef / InstanceDef / ClassDef rustdoc points
at typeclasses contract).
diagnostic.rs (all "(Iter X)" / "(mq.X)" tags on diagnostic codes
removed).
lib.rs (FORM_A_SPEC rustdoc points at authoring-surface.md
instead of "Decision 6").
canonical.rs (type_hash + Float-literal rustdoc).
Still outstanding (for a follow-up commit): ~500 inline `//`
code-body comments with `Iter X.Y` markers across the workspace, and
a handful of `///` rustdoc items in hash_pin / workspace_pin / lift /
mono / suppress_filter test-pin and internal-function bodies. Code
identifiers (test filenames like `mq3_multi_class_e2e.rs`, function
names like `iter18e_drop_iterative_default_preserves_hashes`) stay
verbatim per the user's "code identifiers stay verbatim" rule.
Tests: design_index_pin 5/5 + docs_honesty_pin 5/5; workspace builds
clean; full `cargo test --workspace` previously green (every
`test result: ok` line, no FAILED line).
120 lines
4.8 KiB
Rust
120 lines
4.8 KiB
Rust
//! RED-pin for the 2026-05-14 Cat-A heap-Str leak in `print`
|
|
//! (uncovered during the per-type-print-op retirement).
|
|
//!
|
|
//! Property protected: under `--alloc=rc`, evaluating the trivial
|
|
//! program `(body (app print 42))` does NOT leak the heap-Str
|
|
//! allocated inside `print`'s body. `print`'s body is the explicit-
|
|
//! let `let s = show x in do io/print_str s` (see iter 24.3, pinned
|
|
//! structurally by `print_mono_body_shape.rs`); `show` at primitive
|
|
//! type calls `int_to_str` which returns a fresh heap-Str (slab in
|
|
//! `runtime/str.c`). `io/print_str` borrows the Str. At let-scope-
|
|
//! close, the binder `s` is the only owner — codegen must emit
|
|
//! `ailang_rc_dec(s)`. The runtime stats line at exit must report
|
|
//! `live == 0` (equivalently `allocs == frees`).
|
|
//!
|
|
//! As of commit 301cbc3 this test fails: stderr reports
|
|
//! `ailang_rc_stats: allocs=1 frees=0 live=1`. The IR for the post-
|
|
//! mono `ail_prelude_print__Int` body contains a `call ptr
|
|
//! @ail_prelude_show__Int(...)` followed by `getelementptr +8` +
|
|
//! `@puts` + `ret i8 0` — there is no `ailang_rc_dec` on the
|
|
//! show-result before return. Root cause sits at codegen's
|
|
//! `is_rc_heap_allocated` App-arm: it reads the callee's
|
|
//! `Type::Fn.ret_mode` via `synth_callee_ret_mode` and requires
|
|
//! `Own`. The mono'ed `show__Int` inherits its `Type::Fn` from the
|
|
//! `Show` class method declaration in `examples/prelude.ail.json`,
|
|
//! whose `methods[0].type` omits the `ret_mode` key — `serde` defaults
|
|
//! the missing field to `ParamMode::Implicit`. So
|
|
//! `synth_callee_ret_mode(show__Int) == Implicit`, the let-binder is
|
|
//! not flagged trackable, and `drop_symbol_for_binder` is never
|
|
//! called for it.
|
|
//!
|
|
//! Once the underlying issue is fixed (the canonical move is to
|
|
//! recognise that any class-method whose declared `ret` is `Str` /
|
|
//! any pointer-typed user type should round-trip as Own through
|
|
//! mono, OR to install the Show class declaration with explicit
|
|
//! `ret_mode: "own"`, OR to widen `is_rc_heap_allocated`'s App-arm
|
|
//! to also consult the callee's ret type-via-Str-carve-out), this
|
|
//! test must flip GREEN without weakening the assertion.
|
|
|
|
use std::path::Path;
|
|
use std::process::Command;
|
|
|
|
fn ail_bin() -> &'static str {
|
|
env!("CARGO_BIN_EXE_ail")
|
|
}
|
|
|
|
#[test]
|
|
fn alloc_rc_print_int_does_not_leak_show_result_str() {
|
|
let manifest_dir = env!("CARGO_MANIFEST_DIR");
|
|
let workspace = Path::new(manifest_dir).parent().unwrap().parent().unwrap();
|
|
let src = workspace
|
|
.join("examples")
|
|
.join("print_int_no_leak_pin.ail");
|
|
let tmp = std::env::temp_dir().join(format!(
|
|
"ailang_print_no_leak_pin_{}",
|
|
std::process::id()
|
|
));
|
|
std::fs::create_dir_all(&tmp).unwrap();
|
|
let out = tmp.join("bin");
|
|
let status = Command::new(ail_bin())
|
|
.args([
|
|
"build",
|
|
src.to_str().unwrap(),
|
|
"--alloc=rc",
|
|
"-o",
|
|
])
|
|
.arg(&out)
|
|
.status()
|
|
.expect("ail build failed to run");
|
|
assert!(
|
|
status.success(),
|
|
"ail build --alloc=rc failed for print_int_no_leak_pin.ail"
|
|
);
|
|
let output = Command::new(&out)
|
|
.env("AILANG_RC_STATS", "1")
|
|
.output()
|
|
.expect("execute binary");
|
|
assert!(
|
|
output.status.success(),
|
|
"binary exited non-zero: status {:?}",
|
|
output.status
|
|
);
|
|
let stderr = String::from_utf8(output.stderr).expect("stderr utf8");
|
|
let stats_line = stderr
|
|
.lines()
|
|
.find(|l| l.starts_with("ailang_rc_stats:"))
|
|
.unwrap_or_else(|| {
|
|
panic!(
|
|
"missing ailang_rc_stats line in stderr; stderr was:\n{stderr}"
|
|
)
|
|
});
|
|
let mut allocs: Option<u64> = None;
|
|
let mut frees: Option<u64> = None;
|
|
let mut live: Option<i64> = None;
|
|
for tok in stats_line.split_whitespace() {
|
|
if let Some(v) = tok.strip_prefix("allocs=") {
|
|
allocs = v.parse().ok();
|
|
} else if let Some(v) = tok.strip_prefix("frees=") {
|
|
frees = v.parse().ok();
|
|
} else if let Some(v) = tok.strip_prefix("live=") {
|
|
live = v.parse().ok();
|
|
}
|
|
}
|
|
let allocs = allocs.expect("missing allocs= field");
|
|
let frees = frees.expect("missing frees= field");
|
|
let live = live.expect("missing live= field");
|
|
assert_eq!(
|
|
live, 0,
|
|
"`(app print 42)` under --alloc=rc leaks {live} heap-Str cell(s) \
|
|
(allocs={allocs} frees={frees}); print's let-binder for the \
|
|
show-result must drop at let-scope-close. Show class method \
|
|
`show` in prelude.ail.json omits `ret_mode`, so mono-synthesised \
|
|
`show__Int` inherits ret_mode=Implicit and `is_rc_heap_allocated` \
|
|
declines to track the let-binder."
|
|
);
|
|
assert_eq!(
|
|
allocs, frees,
|
|
"alloc/free mismatch (allocs={allocs} frees={frees} live={live})"
|
|
);
|
|
}
|