Skip to main content

cljrs_value/
types.rs

1//! Stub types for Phase 4/7 that are referenced by the Value enum.
2
3#![allow(unused)]
4
5use std::collections::HashMap;
6use std::mem;
7use std::sync::{Arc, Condvar, Mutex};
8
9use cljrs_gc::GcPtr;
10use cljrs_reader::Form;
11
12use crate::TypeHint;
13use crate::Value;
14
15// ── No-GC debug provenance helper ────────────────────────────────────────────
16
17/// In `no-gc` debug builds: return `true` if the top-level `GcPtr` inside
18/// `value` (if any) was allocated by the global `StaticArena`.
19///
20/// Primitives (`Nil`, `Bool`, `Long`, `Double`, `Char`) contain no `GcPtr`
21/// and always return `true`.  `Resource` is Arc-managed and also returns
22/// `true`.  All other variants have a `GcPtr` that is checked against the
23/// static arena's chunk range.
24///
25/// This check is intentionally **shallow** (top-level pointer only).  If the
26/// value was produced inside a `StaticCtxGuard`, ALL allocations during its
27/// evaluation go to the static arena — so a static top-level pointer implies
28/// static contents.
29#[cfg(all(feature = "no-gc", debug_assertions))]
30pub(crate) fn value_gcptr_is_static(value: &Value) -> bool {
31    use crate::value::MapValue;
32    use crate::value::SetValue;
33    match value {
34        // Inline scalars — no GcPtr.
35        Value::Nil
36        | Value::Bool(_)
37        | Value::Long(_)
38        | Value::Double(_)
39        | Value::Char(_)
40        | Value::Uuid(_) => true,
41        // Arc-managed — not GcPtr; always considered static.
42        Value::Resource(_) | Value::SharedAtom(_) | Value::ByteBlob(_) => true,
43        // GcPtr variants.
44        Value::BigInt(p) => p.is_static_alloc(),
45        Value::BigDecimal(p) => p.is_static_alloc(),
46        Value::Ratio(p) => p.is_static_alloc(),
47        Value::Str(p) => p.is_static_alloc(),
48        Value::Pattern(p) => p.is_static_alloc(),
49        Value::Matcher(p) => p.is_static_alloc(),
50        Value::Symbol(p) => p.is_static_alloc(),
51        Value::Keyword(p) => p.is_static_alloc(),
52        Value::List(p) => p.is_static_alloc(),
53        Value::Vector(p) => p.is_static_alloc(),
54        Value::Queue(p) => p.is_static_alloc(),
55        Value::Map(m) => match m {
56            MapValue::Array(p) => p.is_static_alloc(),
57            MapValue::Hash(p) => p.is_static_alloc(),
58            MapValue::Sorted(p) => p.is_static_alloc(),
59        },
60        Value::Set(s) => match s {
61            SetValue::Hash(p) => p.is_static_alloc(),
62            SetValue::Sorted(p) => p.is_static_alloc(),
63        },
64        Value::NativeFunction(p) => p.is_static_alloc(),
65        Value::Fn(p) | Value::Macro(p) => p.is_static_alloc(),
66        Value::BoundFn(p) => p.is_static_alloc(),
67        Value::Var(p) => p.is_static_alloc(),
68        Value::Atom(p) => p.is_static_alloc(),
69        Value::Namespace(p) => p.is_static_alloc(),
70        Value::LazySeq(p) => p.is_static_alloc(),
71        Value::Cons(p) => p.is_static_alloc(),
72        Value::Protocol(p) => p.is_static_alloc(),
73        Value::ProtocolFn(p) => p.is_static_alloc(),
74        Value::MultiFn(p) => p.is_static_alloc(),
75        Value::Volatile(p) => p.is_static_alloc(),
76        Value::Delay(p) => p.is_static_alloc(),
77        Value::Promise(p) => p.is_static_alloc(),
78        Value::Future(p) => p.is_static_alloc(),
79        Value::Agent(p) => p.is_static_alloc(),
80        Value::TypeInstance(p) => p.is_static_alloc(),
81        Value::ObjectArray(p) => p.is_static_alloc(),
82        Value::NativeObject(p) => p.is_static_alloc(),
83        Value::Error(p) => p.is_static_alloc(),
84        Value::TransientMap(p) => p.is_static_alloc(),
85        Value::TransientVector(p) => p.is_static_alloc(),
86        Value::TransientSet(p) => p.is_static_alloc(),
87        // Primitive arrays — no meaningful pointer check needed.
88        Value::BooleanArray(_)
89        | Value::ByteArray(_)
90        | Value::ShortArray(_)
91        | Value::IntArray(_)
92        | Value::LongArray(_)
93        | Value::FloatArray(_)
94        | Value::DoubleArray(_)
95        | Value::CharArray(_) => true,
96        // Wrapper variants.
97        Value::Reduced(inner) | Value::WithMeta(inner, _) => value_gcptr_is_static(inner),
98    }
99}
100
101// ── Protocol ──────────────────────────────────────────────────────────────────
102
103/// Inner map type for protocol implementations: method_name → impl fn.
104pub type MethodMap = HashMap<Arc<str>, Value>;
105
106/// A Clojure protocol — an interface-like construct with named methods.
107#[derive(Debug)]
108pub struct Protocol {
109    pub name: Arc<str>,
110    pub ns: Arc<str>,
111    pub methods: Vec<ProtocolMethod>,
112    /// type_tag → { method_name → impl fn }
113    pub impls: Mutex<HashMap<Arc<str>, MethodMap>>,
114}
115
116impl Protocol {
117    pub fn new(name: Arc<str>, ns: Arc<str>, methods: Vec<ProtocolMethod>) -> Self {
118        Self {
119            name,
120            ns,
121            methods,
122            impls: Mutex::new(HashMap::new()),
123        }
124    }
125}
126
127/// Global protocol-extension generation, bumped on every `impls` mutation
128/// (`extend-type`, `extend-protocol`, `defrecord`/`reify` inline impls).
129///
130/// Inline caches for protocol dispatch (Phase 10.6, `rt_call_ic` in
131/// `cljrs-compiler`'s rt_abi) tag each cached `(dispatch type → impl fn)`
132/// entry with the generation observed at fill time; a later bump invalidates
133/// every cache entry at once, so re-extending a protocol mid-session is
134/// picked up on the next dispatch through any call site.
135static PROTOCOL_GENERATION: std::sync::atomic::AtomicU64 = std::sync::atomic::AtomicU64::new(0);
136
137/// Current protocol-extension generation (see [`bump_protocol_generation`]).
138pub fn protocol_generation() -> u64 {
139    PROTOCOL_GENERATION.load(std::sync::atomic::Ordering::Acquire)
140}
141
142/// Invalidate all protocol-dispatch inline caches.  Must be called after
143/// every mutation of any [`Protocol::impls`] map.
144pub fn bump_protocol_generation() {
145    PROTOCOL_GENERATION.fetch_add(1, std::sync::atomic::Ordering::AcqRel);
146}
147
148impl cljrs_gc::Trace for Protocol {
149    fn trace(&self, visitor: &mut cljrs_gc::MarkVisitor) {
150        {
151            let impls = self.impls.lock().unwrap();
152            for method_map in impls.values() {
153                for v in method_map.values() {
154                    v.trace(visitor);
155                }
156            }
157        }
158    }
159}
160
161/// One method signature declared in a `defprotocol`.
162#[derive(Debug, Clone)]
163pub struct ProtocolMethod {
164    pub name: Arc<str>,
165    pub min_arity: usize,
166    pub variadic: bool,
167}
168
169impl cljrs_gc::Trace for ProtocolMethod {
170    fn trace(&self, _: &mut cljrs_gc::MarkVisitor) {}
171}
172
173// ── ProtocolFn ────────────────────────────────────────────────────────────────
174
175/// Callable that dispatches a single protocol method on the type of `args[0]`.
176#[derive(Debug)]
177pub struct ProtocolFn {
178    pub protocol: GcPtr<Protocol>,
179    pub method_name: Arc<str>,
180    pub min_arity: usize,
181    pub variadic: bool,
182}
183
184impl cljrs_gc::Trace for ProtocolFn {
185    fn trace(&self, visitor: &mut cljrs_gc::MarkVisitor) {
186        use cljrs_gc::GcVisitor as _;
187        visitor.visit(&self.protocol);
188    }
189}
190
191// ── MultiFn ───────────────────────────────────────────────────────────────────
192
193/// A Clojure multimethod — arbitrary dispatch via a user-supplied function.
194#[derive(Debug)]
195pub struct MultiFn {
196    pub name: Arc<str>,
197    pub dispatch_fn: Value,
198    /// pr_str(dispatch-val) → implementation fn
199    pub methods: Mutex<HashMap<String, Value>>,
200    /// recorded preferences (for future derive/hierarchy)
201    pub prefers: Mutex<HashMap<String, Vec<String>>>,
202    /// normally ":default"
203    pub default_dispatch: String,
204}
205
206impl MultiFn {
207    pub fn new(name: Arc<str>, dispatch_fn: Value, default_dispatch: String) -> Self {
208        Self {
209            name,
210            dispatch_fn,
211            methods: Mutex::new(HashMap::new()),
212            prefers: Mutex::new(HashMap::new()),
213            default_dispatch,
214        }
215    }
216}
217
218impl cljrs_gc::Trace for MultiFn {
219    fn trace(&self, visitor: &mut cljrs_gc::MarkVisitor) {
220        self.dispatch_fn.trace(visitor);
221        {
222            let methods = self.methods.lock().unwrap();
223            for v in methods.values() {
224                v.trace(visitor);
225            }
226        }
227    }
228}
229
230// ── Var ───────────────────────────────────────────────────────────────────────
231
232/// A Clojure var — a namespace-interned mutable root binding.
233///
234/// ## Two-tier root (Phase B3, issue #171)
235///
236/// A var's *root* binding uses the same two-tier mechanism as `shared-atom`:
237///
238/// - **`value`** — the isolate-local, GC-backed fast path.  Every var deref,
239///   the IR tier, and the JIT/AOT `rt_*` ABI read this slot; promotion never
240///   touches it, so compiled inline caches and pointer-identity assumptions
241///   baked into native code stay valid.
242/// - **`shared_root`** — a `Send + Sync` cross-isolate mirror,
243///   `Arc<ArcSwap<Option<SharedValue>>>`, reusing
244///   [`crate::shared::SharedValue`].  `bind` (i.e. `def` / `alter-var-root` /
245///   `set!`) *promotes-on-write*: if the new root value is promotable the cell
246///   holds `Some(SharedValue)`, otherwise it is cleared to `None` (option (b)
247///   of the ADR — non-promotable roots, e.g. closures, stay isolate-local).
248///
249/// The shared cell is what crosses the structured-clone boundary: a var
250/// `def`'d in one isolate is observable *by value* from another, with keyword
251/// /symbol identity preserved through the intern table.  See
252/// `crate::clone` for the serialize/deserialize seam.
253///
254/// Dynamic `binding` is unchanged — it is already thread-local / per-isolate
255/// and lives on the binding stack, not in the var root.
256#[derive(Debug)]
257pub struct Var {
258    pub namespace: Arc<str>,
259    pub name: Arc<str>,
260    pub value: Mutex<Option<Value>>,
261    /// Cross-isolate mirror of the root binding (Phase B3).  `None` when the
262    /// var is unbound or its current root is not promotable.
263    pub shared_root: Arc<arc_swap::ArcSwap<Option<crate::shared::SharedValue>>>,
264    pub is_macro: bool,
265    /// Metadata map (e.g. `{:dynamic true}`).
266    pub meta: Mutex<Option<Value>>,
267    pub watches: Mutex<Vec<(Value, Value)>>,
268}
269
270impl Var {
271    pub fn new(namespace: impl Into<Arc<str>>, name: impl Into<Arc<str>>) -> Self {
272        Self {
273            namespace: namespace.into(),
274            name: name.into(),
275            value: Mutex::new(None),
276            shared_root: Arc::new(arc_swap::ArcSwap::new(Arc::new(None))),
277            is_macro: false,
278            meta: Mutex::new(None),
279            watches: Mutex::new(Vec::new()),
280        }
281    }
282
283    /// Reconstruct a var on the receiving side of an isolate boundary.
284    ///
285    /// The `shared_root` cell is the *same* `Arc` as the sending isolate's, so
286    /// both isolates share the cross-isolate root cell.  The local `value`
287    /// fast-path slot is seeded by demoting the current shared snapshot, so an
288    /// immediate `deref` observes the value the var carried at crossing time.
289    pub fn from_shared_root(
290        namespace: impl Into<Arc<str>>,
291        name: impl Into<Arc<str>>,
292        is_macro: bool,
293        shared_root: Arc<arc_swap::ArcSwap<Option<crate::shared::SharedValue>>>,
294    ) -> Self {
295        let local = shared_root
296            .load()
297            .as_ref()
298            .as_ref()
299            .map(crate::shared::demote);
300        Self {
301            namespace: namespace.into(),
302            name: name.into(),
303            value: Mutex::new(local),
304            shared_root,
305            is_macro,
306            meta: Mutex::new(None),
307            watches: Mutex::new(Vec::new()),
308        }
309    }
310
311    pub fn is_bound(&self) -> bool {
312        self.value.lock().unwrap().is_some()
313    }
314
315    pub fn deref(&self) -> Option<Value> {
316        self.value.lock().unwrap().clone()
317    }
318
319    /// Read the cross-isolate root by demoting the shared cell, ignoring the
320    /// isolate-local fast path.  Returns `None` when the shared root is empty
321    /// (unbound or non-promotable).  Used to observe writes another isolate
322    /// made through the shared cell.
323    pub fn deref_shared(&self) -> Option<Value> {
324        self.shared_root
325            .load()
326            .as_ref()
327            .as_ref()
328            .map(crate::shared::demote)
329    }
330
331    pub fn bind(&self, v: Value) {
332        // In no-gc debug builds: assert the value being stored in this
333        // program-lifetime Var came from the StaticArena, not a scratch region.
334        // A region-local pointer would dangle after the function returns.
335        #[cfg(all(feature = "no-gc", debug_assertions))]
336        debug_assert!(
337            value_gcptr_is_static(&v),
338            "no-gc: Var::bind({}/{}) received a region-local value — store violations \
339             indicate a missing StaticCtxGuard around the value expression",
340            self.namespace,
341            self.name
342        );
343        // GC builds: heap-promotion fallback — a region-allocated value bound
344        // to a program-lifetime var is deep-copied to the heap (or the active
345        // regions are retired when it cannot be).  One depth check when no
346        // region is open.
347        let v = crate::publish::publish_value(v);
348        // Replace the binding, holding the lock only across the swap.  The
349        // previous value (if any) is handed to the JIT rebind hook so it can
350        // reclaim native code compiled for a now-superseded definition
351        // (Phase 10.2 — code unloading).  `v.clone()` is O(1) for the only
352        // values that carry compiled code (`Value::Fn`, a `GcPtr` clone).
353        let prev = {
354            let mut slot = self.value.lock().unwrap();
355            slot.replace(v.clone())
356        };
357        // Promote-on-`def` (Phase B3): mirror the new root into the
358        // cross-isolate cell when it is promotable, else clear the cell so it
359        // never advertises a stale or non-shareable root.  `def` is rare and
360        // global by nature, so this write-path cost is acceptable; the read
361        // path (and the JIT) never touch the shared cell.
362        let shared = crate::shared::promote(&v).ok();
363        self.shared_root.store(Arc::new(shared));
364        if let Some(prev) = prev {
365            crate::jit_hooks::notify_var_rebind(&prev, &v);
366        }
367    }
368
369    pub fn get_meta(&self) -> Option<Value> {
370        self.meta.lock().unwrap().clone()
371    }
372
373    pub fn set_meta(&self, m: Value) {
374        *self.meta.lock().unwrap() = Some(m);
375    }
376
377    pub fn full_name(&self) -> String {
378        format!("{}/{}", self.namespace, self.name)
379    }
380}
381
382impl cljrs_gc::Trace for Var {
383    fn trace(&self, visitor: &mut cljrs_gc::MarkVisitor) {
384        {
385            let value = self.value.lock().unwrap();
386            if let Some(v) = value.as_ref() {
387                v.trace(visitor);
388            }
389        }
390        {
391            let meta = self.meta.lock().unwrap();
392            if let Some(m) = meta.as_ref() {
393                m.trace(visitor);
394            }
395        }
396        {
397            let watches = self.watches.lock().unwrap();
398            for (key, f) in watches.iter() {
399                key.trace(visitor);
400                f.trace(visitor);
401            }
402        }
403    }
404}
405
406// ── Atom ──────────────────────────────────────────────────────────────────────
407
408/// A Clojure atom — a thread-safe mutable reference.
409#[derive(Debug)]
410pub struct Atom {
411    pub value: Mutex<Value>,
412    pub meta: Mutex<Option<Value>>,
413    pub validator: Mutex<Option<Value>>,
414    pub watches: Mutex<Vec<(Value, Value)>>,
415}
416
417impl Atom {
418    pub fn new(v: Value) -> Self {
419        // Heap-promotion fallback (GC builds): an atom is program-lifetime
420        // shared state, so its initial value must not be region-allocated.
421        let v = crate::publish::publish_value(v);
422        Self {
423            value: Mutex::new(v),
424            meta: Mutex::new(None),
425            validator: Mutex::new(None),
426            watches: Mutex::new(Vec::new()),
427        }
428    }
429
430    pub fn deref(&self) -> Value {
431        self.value.lock().unwrap().clone()
432    }
433
434    pub fn reset(&self, v: Value) -> Value {
435        // In no-gc debug builds: assert the new value came from the StaticArena.
436        #[cfg(all(feature = "no-gc", debug_assertions))]
437        debug_assert!(
438            value_gcptr_is_static(&v),
439            "no-gc: Atom::reset() received a region-local value — the new-value \
440             expression must be computed inside a StaticCtxGuard (i.e. inside \
441             the swap! / reset! call) so it is allocated in the static arena"
442        );
443        // GC builds: heap-promotion fallback (see `Var::bind`).
444        let v = crate::publish::publish_value(v);
445        let mut guard = self.value.lock().unwrap();
446        *guard = v.clone();
447        v
448    }
449
450    pub fn get_meta(&self) -> Option<Value> {
451        self.meta.lock().unwrap().clone()
452    }
453
454    pub fn set_meta(&self, m: Option<Value>) {
455        *self.meta.lock().unwrap() = m;
456    }
457
458    pub fn get_validator(&self) -> Option<Value> {
459        self.validator.lock().unwrap().clone()
460    }
461
462    pub fn set_validator(&self, vf: Option<Value>) {
463        *self.validator.lock().unwrap() = vf;
464    }
465}
466
467impl cljrs_gc::Trace for Atom {
468    fn trace(&self, visitor: &mut cljrs_gc::MarkVisitor) {
469        {
470            let value = self.value.lock().unwrap();
471            value.trace(visitor);
472        }
473        {
474            let meta = self.meta.lock().unwrap();
475            if let Some(m) = meta.as_ref() {
476                m.trace(visitor);
477            }
478        }
479        {
480            let validator = self.validator.lock().unwrap();
481            if let Some(vf) = validator.as_ref() {
482                vf.trace(visitor);
483            }
484        }
485        {
486            let watches = self.watches.lock().unwrap();
487            for (key, f) in watches.iter() {
488                key.trace(visitor);
489                f.trace(visitor);
490            }
491        }
492    }
493}
494
495// ── Namespace ─────────────────────────────────────────────────────────────────
496
497/// A Clojure namespace with intern table, refers, and aliases.
498#[derive(Debug)]
499pub struct Namespace {
500    pub name: Arc<str>,
501    /// Vars interned directly in this namespace.
502    pub interns: Mutex<HashMap<Arc<str>, GcPtr<Var>>>,
503    /// Vars referred from other namespaces (e.g. clojure.core).
504    pub refers: Mutex<HashMap<Arc<str>, GcPtr<Var>>>,
505    /// Namespace aliases: short-name → full namespace name.
506    pub aliases: Mutex<HashMap<Arc<str>, Arc<str>>>,
507    /// Absolute path of the source file this namespace was loaded from,
508    /// populated by the loader.  Used by the versioned resolver to locate the
509    /// file for `git show`.
510    pub source_file: Mutex<Option<Arc<str>>>,
511    /// Absolute path of the git repository root that contains `source_file`.
512    pub git_repo_root: Mutex<Option<Arc<str>>>,
513    /// `true` for namespaces loaded from a specific commit (`name@hash`).
514    /// Versioned namespaces are immutable: `intern()` will refuse new bindings.
515    pub is_versioned: bool,
516}
517
518impl Namespace {
519    pub fn new(name: impl Into<Arc<str>>) -> Self {
520        Self {
521            name: name.into(),
522            interns: Mutex::new(HashMap::new()),
523            refers: Mutex::new(HashMap::new()),
524            aliases: Mutex::new(HashMap::new()),
525            source_file: Mutex::new(None),
526            git_repo_root: Mutex::new(None),
527            is_versioned: false,
528        }
529    }
530
531    /// Create a versioned (immutable) namespace for `name@commit`.
532    pub fn new_versioned(name: impl Into<Arc<str>>) -> Self {
533        Self {
534            is_versioned: true,
535            ..Self::new(name)
536        }
537    }
538
539    /// Record the source file path and its git repo root (if in a repo).
540    pub fn set_source_location(&self, file: &str, repo_root: Option<&str>) {
541        *self.source_file.lock().unwrap() = Some(Arc::from(file));
542        *self.git_repo_root.lock().unwrap() = repo_root.map(Arc::from);
543    }
544}
545
546impl cljrs_gc::Trace for Namespace {
547    fn trace(&self, visitor: &mut cljrs_gc::MarkVisitor) {
548        use cljrs_gc::GcVisitor as _;
549        {
550            let interns = self.interns.lock().unwrap();
551            for var in interns.values() {
552                visitor.visit(var);
553            }
554        }
555        {
556            let refers = self.refers.lock().unwrap();
557            for var in refers.values() {
558                visitor.visit(var);
559            }
560        }
561    }
562}
563
564// ── NativeFn ──────────────────────────────────────────────────────────────────
565
566/// A Rust function callable from Clojure.
567/// Legacy type alias kept for source compatibility. Bare `fn` pointers
568/// implement `Fn` and can be passed anywhere a `NativeFnFunc` is expected.
569pub type NativeFnPtr = fn(&[Value]) -> crate::error::ValueResult<Value>;
570
571/// The callable stored inside a `NativeFn`. Supports both bare function
572/// pointers and closures that capture state.
573pub type NativeFnFunc = Arc<dyn Fn(&[Value]) -> crate::error::ValueResult<Value>>;
574
575#[derive(Clone, Debug)]
576pub enum Arity {
577    Fixed(usize),
578    Variadic { min: usize },
579}
580
581pub struct NativeFn {
582    pub name: Arc<str>,
583    pub arity: Arity,
584    pub func: NativeFnFunc,
585}
586
587impl NativeFn {
588    /// Create from a bare function pointer (backwards-compatible).
589    pub fn new(name: impl Into<Arc<str>>, arity: Arity, func: NativeFnPtr) -> Self {
590        Self {
591            name: name.into(),
592            arity,
593            func: Arc::new(func),
594        }
595    }
596
597    /// Create from a closure or any `Fn(&[Value]) -> ValueResult<Value>`.
598    pub fn with_closure(
599        name: impl Into<Arc<str>>,
600        arity: Arity,
601        func: impl Fn(&[Value]) -> crate::error::ValueResult<Value> + 'static,
602    ) -> Self {
603        Self {
604            name: name.into(),
605            arity,
606            func: Arc::new(func),
607        }
608    }
609}
610
611impl std::fmt::Debug for NativeFn {
612    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
613        f.debug_struct("NativeFn")
614            .field("name", &self.name)
615            .field("arity", &self.arity)
616            .field("func", &"<fn>")
617            .finish()
618    }
619}
620
621impl cljrs_gc::Trace for NativeFn {
622    fn trace(&self, _: &mut cljrs_gc::MarkVisitor) {}
623}
624
625// ── CljxFnArity ───────────────────────────────────────────────────────────────
626
627/// One arity branch of a Clojure function.
628#[derive(Debug, Clone)]
629pub struct CljxFnArity {
630    /// Simple parameter names (no `&`).
631    /// For destructured params, these are gensym'd names.
632    pub params: Vec<Arc<str>>,
633    /// The name after `&`, if any.
634    pub rest_param: Option<Arc<str>>,
635    /// The body forms for this arity.
636    pub body: Vec<Form>,
637    /// Destructuring patterns: (param_index, original_form).
638    /// After binding the gensym'd param, these patterns are applied
639    /// via `bind_pattern` to destructure the value.
640    pub destructure_params: Vec<(usize, Form)>,
641    /// If the rest param is destructured, the original form.
642    pub destructure_rest: Option<Form>,
643    /// Unique ID for IR cache lookup (assigned by the evaluator).
644    pub ir_arity_id: u64,
645    /// Optional primitive type hint per positional parameter (parallel to
646    /// `params`).  `^long x` → `Some(TypeHint::Long)`; an un-hinted or
647    /// non-primitive-tagged param → `None`.  Drives unboxed codegen.
648    pub param_hints: Vec<Option<TypeHint>>,
649    /// Primitive type hint on the rest param, if any (rarely useful, but parsed
650    /// for symmetry).
651    pub rest_hint: Option<TypeHint>,
652}
653
654impl CljxFnArity {
655    /// Heap bytes owned by this arity, not counting the `CljxFnArity` struct itself.
656    pub fn heap_size(&self) -> usize {
657        // params Vec buffer (Arc<str> pointers; the str data is shared, skip it)
658        self.params.capacity() * mem::size_of::<Arc<str>>()
659        // body: the dominant consumer — Form AST trees stored inline
660        + self.body.capacity() * mem::size_of::<Form>()
661        + self.body.iter().map(|f| f.heap_size()).sum::<usize>()
662        // destructure_params
663        + self.destructure_params.capacity() * mem::size_of::<(usize, Form)>()
664        + self.destructure_params.iter().map(|(_, f)| f.heap_size()).sum::<usize>()
665        // destructure_rest
666        + self.destructure_rest.as_ref()
667            .map_or(0, |f| mem::size_of::<Form>() + f.heap_size())
668        // param_hints (Copy elements, no nested heap)
669        + self.param_hints.capacity() * mem::size_of::<Option<TypeHint>>()
670    }
671}
672
673// ── CljxFn ────────────────────────────────────────────────────────────────────
674
675/// An interpreted Clojure closure with captured environment.
676#[derive(Debug, Clone)]
677pub struct CljxFn {
678    pub name: Option<Arc<str>>,
679    pub arities: Vec<CljxFnArity>,
680    /// Names of closed-over bindings (parallel to `closed_over_vals`).
681    pub closed_over_names: Vec<Arc<str>>,
682    /// Values of closed-over bindings (parallel to `closed_over_names`).
683    pub closed_over_vals: Vec<Value>,
684    /// True if this function was defined with `defmacro`.
685    pub is_macro: bool,
686    /// True if this function carries `^:async` metadata. When an async runtime
687    /// (`cljrs-async`) is registered, calling such a function spawns its body as
688    /// a task and returns a `Value::Future` immediately instead of running it
689    /// synchronously. Without a runtime it runs synchronously like any other fn.
690    pub is_async: bool,
691    /// Namespace in which this function was defined (for macro hygiene).
692    pub defining_ns: Arc<str>,
693}
694
695impl CljxFn {
696    pub fn new(
697        name: Option<Arc<str>>,
698        arities: Vec<CljxFnArity>,
699        closed_over_names: Vec<Arc<str>>,
700        closed_over_vals: Vec<Value>,
701        is_macro: bool,
702        defining_ns: Arc<str>,
703    ) -> Self {
704        Self {
705            name,
706            arities,
707            closed_over_names,
708            closed_over_vals,
709            is_macro,
710            is_async: false,
711            defining_ns,
712        }
713    }
714}
715
716impl cljrs_gc::Trace for CljxFn {
717    fn trace(&self, visitor: &mut cljrs_gc::MarkVisitor) {
718        for v in &self.closed_over_vals {
719            v.trace(visitor);
720        }
721    }
722
723    fn gc_size_extra(&self) -> usize {
724        // Vec<CljxFnArity> buffer + each arity's inline-owned heap
725        self.arities.capacity() * mem::size_of::<CljxFnArity>()
726            + self
727                .arities
728                .iter()
729                .map(CljxFnArity::heap_size)
730                .sum::<usize>()
731    }
732}
733
734// ── BoundFn ──────────────────────────────────────────────────────────────────
735
736/// A function wrapped with captured dynamic bindings.
737/// When called, the captured bindings are pushed as a frame before delegating
738/// to the wrapped function. This means captured bindings override the caller's
739/// for the same var, but vars not in the capture fall through normally.
740#[derive(Debug)]
741pub struct BoundFn {
742    /// The wrapped callable.
743    pub wrapped: Value,
744    /// Captured dynamic bindings (merged flat frame; opaque to cljrs-value).
745    pub captured_bindings: HashMap<usize, Value>,
746}
747
748impl cljrs_gc::Trace for BoundFn {
749    fn trace(&self, visitor: &mut cljrs_gc::MarkVisitor) {
750        self.wrapped.trace(visitor);
751        for val in self.captured_bindings.values() {
752            val.trace(visitor);
753        }
754    }
755
756    fn gc_size_extra(&self) -> usize {
757        // HashMap<usize, Value>: hashbrown open-addressing, ~1 control byte + entry per slot.
758        self.captured_bindings.capacity() * (1 + mem::size_of::<usize>() + mem::size_of::<Value>())
759    }
760}
761
762// ── Thunk / LazySeq ───────────────────────────────────────────────────────────
763
764/// A deferred computation that produces a `Value` when forced.
765pub trait Thunk: std::fmt::Debug + cljrs_gc::Trace {
766    fn force(&self) -> Result<Value, String>;
767}
768
769/// Internal state of a lazy sequence cell.
770pub enum LazySeqState {
771    /// Thunk not yet evaluated.
772    Pending(Box<dyn Thunk>),
773    /// Result cached after first force.
774    Forced(Value),
775    /// Thunk evaluation failed; error message is cached.
776    Error(String),
777}
778
779/// A lazy sequence that forces its thunk exactly once and caches the result.
780pub struct LazySeq {
781    pub state: Mutex<LazySeqState>,
782}
783
784impl LazySeq {
785    pub fn new(thunk: Box<dyn Thunk>) -> Self {
786        Self {
787            state: Mutex::new(LazySeqState::Pending(thunk)),
788        }
789    }
790
791    /// Realize the sequence: force the thunk on first call, return cached value on subsequent calls.
792    /// On error, returns `Value::Nil` and caches the error (retrievable via `error()`).
793    pub fn realize(&self) -> Value {
794        let thunk = {
795            let mut guard = self.state.lock().unwrap();
796            match &*guard {
797                LazySeqState::Forced(v) => return v.clone(),
798                LazySeqState::Error(_) => return Value::Nil,
799                LazySeqState::Pending(_) => {}
800            }
801            // Replace the pending state with a temporary Forced(Nil), extract the thunk.
802            let prev = mem::replace(&mut *guard, LazySeqState::Forced(Value::Nil));
803            let LazySeqState::Pending(thunk) = prev else {
804                unreachable!("state was not Pending")
805            };
806            thunk
807            // guard dropped here — lock released before forcing
808        };
809        // Force the thunk WITHOUT holding the lock. This ensures GC's
810        // lock().unwrap() in LazySeq::trace() will not deadlock.
811        match thunk.force() {
812            Ok(result) => {
813                *self.state.lock().unwrap() = LazySeqState::Forced(result.clone());
814                result
815            }
816            Err(msg) => {
817                *self.state.lock().unwrap() = LazySeqState::Error(msg);
818                Value::Nil
819            }
820        }
821    }
822
823    /// Return the cached error message, if the thunk failed.
824    pub fn error(&self) -> Option<String> {
825        let guard = self.state.lock().unwrap();
826        if let LazySeqState::Error(e) = &*guard {
827            Some(e.clone())
828        } else {
829            None
830        }
831    }
832}
833
834impl std::fmt::Debug for LazySeq {
835    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
836        write!(f, "LazySeq(...)")
837    }
838}
839
840impl cljrs_gc::Trace for LazySeq {
841    fn trace(&self, visitor: &mut cljrs_gc::MarkVisitor) {
842        // Safe to lock unconditionally: realize() drops the lock before entering
843        // eval (thunk.force()), so the lock is never held across a GC safepoint.
844        {
845            let state = self.state.lock().unwrap();
846            match &*state {
847                LazySeqState::Pending(thunk) => thunk.trace(visitor),
848                LazySeqState::Forced(v) => v.trace(visitor),
849                LazySeqState::Error(_) => {}
850            }
851        }
852    }
853}
854
855// ── CljxCons ──────────────────────────────────────────────────────────────────
856
857/// A lazy cons cell: head element + tail (may be a `LazySeq`, `List`, or `Nil`).
858///
859/// Used when `cons` is called with a `LazySeq` or `Cons` tail, enabling lazy
860/// sequences without eagerly realizing them.
861#[derive(Debug, Clone)]
862pub struct CljxCons {
863    pub head: Value,
864    pub tail: Value,
865}
866
867impl cljrs_gc::Trace for CljxCons {
868    fn trace(&self, visitor: &mut cljrs_gc::MarkVisitor) {
869        self.head.trace(visitor);
870        self.tail.trace(visitor);
871    }
872}
873
874// ── Volatile ──────────────────────────────────────────────────────────────────
875
876/// Non-atomic mutable cell (single-thread performance, no CAS).
877pub struct Volatile {
878    pub value: Mutex<Value>,
879}
880
881impl Volatile {
882    pub fn new(v: Value) -> Self {
883        // GC builds: heap-promotion fallback (see `Var::bind`).
884        let v = crate::publish::publish_value(v);
885        Self {
886            value: Mutex::new(v),
887        }
888    }
889
890    pub fn deref(&self) -> Value {
891        self.value.lock().unwrap().clone()
892    }
893
894    pub fn reset(&self, v: Value) -> Value {
895        // In no-gc debug builds: assert the new value came from the StaticArena.
896        #[cfg(all(feature = "no-gc", debug_assertions))]
897        debug_assert!(
898            value_gcptr_is_static(&v),
899            "no-gc: Volatile::reset() received a region-local value — ensure the \
900             new-value expression is inside a StaticCtxGuard (vreset! handles this)"
901        );
902        // GC builds: heap-promotion fallback (see `Var::bind`).
903        let v = crate::publish::publish_value(v);
904        *self.value.lock().unwrap() = v.clone();
905        v
906    }
907}
908
909impl std::fmt::Debug for Volatile {
910    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
911        write!(f, "Volatile")
912    }
913}
914
915impl cljrs_gc::Trace for Volatile {
916    fn trace(&self, visitor: &mut cljrs_gc::MarkVisitor) {
917        {
918            let value = self.value.lock().unwrap();
919            value.trace(visitor);
920        }
921    }
922}
923
924// ── Delay ─────────────────────────────────────────────────────────────────────
925
926/// Internal state of a delay cell.
927pub enum DelayState {
928    Pending(Box<dyn Thunk>),
929    Forced(Value),
930}
931
932/// A lazy one-time computation (forced at most once, result cached).
933pub struct Delay {
934    pub state: Mutex<DelayState>,
935}
936
937impl Delay {
938    pub fn new(thunk: Box<dyn Thunk>) -> Self {
939        Self {
940            state: Mutex::new(DelayState::Pending(thunk)),
941        }
942    }
943
944    /// Force the delay and cache the result.
945    /// Returns the value on success, or an error message on failure.
946    pub fn force(&self) -> Result<Value, String> {
947        let thunk = {
948            let mut guard = self.state.lock().unwrap();
949            if let DelayState::Forced(v) = &*guard {
950                return Ok(v.clone());
951            }
952            let prev = mem::replace(&mut *guard, DelayState::Forced(Value::Nil));
953            let DelayState::Pending(thunk) = prev else {
954                unreachable!("state was not Pending")
955            };
956            thunk
957            // guard dropped here — lock released before forcing
958        };
959        // Force the thunk WITHOUT holding the lock so GC's lock().unwrap() in
960        // Delay::trace() will not deadlock.
961        let result = thunk.force()?;
962        *self.state.lock().unwrap() = DelayState::Forced(result.clone());
963        Ok(result)
964    }
965
966    /// True if the delay has already been forced.
967    pub fn is_realized(&self) -> bool {
968        matches!(&*self.state.lock().unwrap(), DelayState::Forced(_))
969    }
970}
971
972impl std::fmt::Debug for Delay {
973    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
974        write!(f, "Delay")
975    }
976}
977
978impl cljrs_gc::Trace for Delay {
979    fn trace(&self, visitor: &mut cljrs_gc::MarkVisitor) {
980        // Safe to lock unconditionally: force() drops the lock before entering
981        // eval (thunk.force()), so the lock is never held across a GC safepoint.
982        {
983            let state = self.state.lock().unwrap();
984            match &*state {
985                DelayState::Pending(thunk) => thunk.trace(visitor),
986                DelayState::Forced(v) => v.trace(visitor),
987            }
988        }
989    }
990}
991
992// ── CljxPromise ───────────────────────────────────────────────────────────────
993
994/// A one-shot rendezvous (promise).
995pub struct CljxPromise {
996    pub value: Mutex<Option<Value>>,
997    pub cond: Condvar,
998}
999
1000impl CljxPromise {
1001    pub fn new() -> Self {
1002        Self {
1003            value: Mutex::new(None),
1004            cond: Condvar::new(),
1005        }
1006    }
1007
1008    /// Deliver a value (no-op if already delivered).
1009    pub fn deliver(&self, v: Value) {
1010        // GC builds: heap-promotion fallback — the promise may outlive (and be
1011        // read from outside) any region scope active at delivery time.
1012        let v = crate::publish::publish_value(v);
1013        let mut guard = self.value.lock().unwrap();
1014        if guard.is_none() {
1015            *guard = Some(v);
1016            self.cond.notify_all();
1017        }
1018    }
1019
1020    /// Block until a value is available, then return it.
1021    pub fn deref_blocking(&self) -> Value {
1022        let mut guard = self.value.lock().unwrap();
1023        while guard.is_none() {
1024            guard = self.cond.wait(guard).unwrap();
1025        }
1026        guard.as_ref().unwrap().clone()
1027    }
1028
1029    /// True if already delivered.
1030    pub fn is_realized(&self) -> bool {
1031        self.value.lock().unwrap().is_some()
1032    }
1033}
1034
1035impl Default for CljxPromise {
1036    fn default() -> Self {
1037        Self::new()
1038    }
1039}
1040
1041impl std::fmt::Debug for CljxPromise {
1042    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1043        write!(f, "Promise")
1044    }
1045}
1046
1047impl cljrs_gc::Trace for CljxPromise {
1048    fn trace(&self, visitor: &mut cljrs_gc::MarkVisitor) {
1049        {
1050            let value = self.value.lock().unwrap();
1051            if let Some(v) = value.as_ref() {
1052                v.trace(visitor);
1053            }
1054        }
1055    }
1056}
1057
1058// ── CljxFuture ────────────────────────────────────────────────────────────────
1059
1060/// Thread-pool future state.
1061pub enum FutureState {
1062    Running,
1063    Done(Value),
1064    /// The future's body threw. Holds the thrown Clojure value (a
1065    /// `Value::Error`) so `await`/`deref` can re-throw it with its
1066    /// `ex-data`/`ex-cause` intact, rather than a stringified message.
1067    Failed(Value),
1068    Cancelled,
1069}
1070
1071/// A future value computed asynchronously on another thread.
1072pub struct CljxFuture {
1073    pub state: Mutex<FutureState>,
1074    pub cond: Condvar,
1075    /// Set once a consumer has read the settled result (via `await`/`deref`).
1076    /// Used to warn about a `Failed` future that is discarded without anyone
1077    /// ever observing its error (the fire-and-forget footgun).
1078    observed: std::sync::atomic::AtomicBool,
1079}
1080
1081impl CljxFuture {
1082    pub fn new() -> Self {
1083        Self {
1084            state: Mutex::new(FutureState::Running),
1085            cond: Condvar::new(),
1086            observed: std::sync::atomic::AtomicBool::new(false),
1087        }
1088    }
1089
1090    /// True if done, failed, or cancelled (not still running).
1091    pub fn is_done(&self) -> bool {
1092        !matches!(&*self.state.lock().unwrap(), FutureState::Running)
1093    }
1094
1095    /// True if explicitly cancelled.
1096    pub fn is_cancelled(&self) -> bool {
1097        matches!(&*self.state.lock().unwrap(), FutureState::Cancelled)
1098    }
1099
1100    /// Mark this future's result as observed. Call when a consumer reads the
1101    /// settled value (`await`/`deref`), so a later drop doesn't warn about an
1102    /// unobserved error.
1103    pub fn mark_observed(&self) {
1104        self.observed
1105            .store(true, std::sync::atomic::Ordering::Relaxed);
1106    }
1107}
1108
1109impl Drop for CljxFuture {
1110    fn drop(&mut self) {
1111        // Warn if a future failed but nobody ever observed the error — the
1112        // fire-and-forget case where a thrown error would otherwise vanish.
1113        // Tied to GC sweep timing: only fires once the future is unreachable,
1114        // so a not-yet-awaited (still reachable) failed future won't warn.
1115        //
1116        // SAFETY: this Drop can run during GC sweep. The thrown value held in
1117        // `Failed(v)` is itself a GC value whose backing box may be freed in
1118        // the *same* sweep, so we must NOT dereference it here (no `{v}`). We
1119        // only inspect the state discriminant, which is inline in our own
1120        // (still-valid) allocation.
1121        if !self.observed.load(std::sync::atomic::Ordering::Relaxed)
1122            && let Ok(state) = self.state.lock()
1123            && matches!(&*state, FutureState::Failed(_))
1124        {
1125            eprintln!(
1126                "[clojurust warning] a failed future was discarded without its error \
1127                 being observed (no await/deref); the thrown exception was lost"
1128            );
1129        }
1130    }
1131}
1132
1133impl Default for CljxFuture {
1134    fn default() -> Self {
1135        Self::new()
1136    }
1137}
1138
1139impl std::fmt::Debug for CljxFuture {
1140    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1141        write!(f, "Future")
1142    }
1143}
1144
1145impl cljrs_gc::Trace for CljxFuture {
1146    fn trace(&self, visitor: &mut cljrs_gc::MarkVisitor) {
1147        {
1148            let state = self.state.lock().unwrap();
1149            // Both Done and Failed hold a Value (the result or the thrown
1150            // error); trace either so the GC keeps it alive until observed.
1151            if let FutureState::Done(v) | FutureState::Failed(v) = &*state {
1152                v.trace(visitor);
1153            }
1154        }
1155    }
1156}
1157
1158// ── Agent ─────────────────────────────────────────────────────────────────────
1159
1160/// A Clojure agent — asynchronous state update queue (stub: not yet implemented).
1161pub struct Agent {
1162    /// Current state.
1163    pub state: Arc<Mutex<Value>>,
1164    /// Last error.
1165    pub error: Arc<Mutex<Option<Value>>>,
1166    pub watches: Mutex<Vec<(Value, Value)>>,
1167}
1168
1169impl Agent {
1170    pub fn get_state(&self) -> Value {
1171        self.state.lock().unwrap().clone()
1172    }
1173
1174    pub fn get_error(&self) -> Option<Value> {
1175        self.error.lock().unwrap().clone()
1176    }
1177
1178    pub fn clear_error(&self) {
1179        *self.error.lock().unwrap() = None;
1180    }
1181}
1182
1183impl std::fmt::Debug for Agent {
1184    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1185        write!(f, "Agent")
1186    }
1187}
1188
1189impl cljrs_gc::Trace for Agent {
1190    fn trace(&self, visitor: &mut cljrs_gc::MarkVisitor) {
1191        {
1192            let state = self.state.lock().unwrap();
1193            state.trace(visitor);
1194        }
1195        {
1196            let error = self.error.lock().unwrap();
1197            if let Some(e) = error.as_ref() {
1198                e.trace(visitor);
1199            }
1200        }
1201        {
1202            let watches = self.watches.lock().unwrap();
1203            for (key, f) in watches.iter() {
1204                key.trace(visitor);
1205                f.trace(visitor);
1206            }
1207        }
1208    }
1209}
1210
1211// ── Tests ─────────────────────────────────────────────────────────────────────
1212
1213#[cfg(test)]
1214mod var_tests {
1215    use super::*;
1216    use crate::shared::SharedValue;
1217
1218    #[test]
1219    fn bind_promotable_mirrors_shared_root() {
1220        let var = Var::new("user", "x");
1221        assert!(var.shared_root.load().is_none());
1222        var.bind(Value::Long(7));
1223        assert!(matches!(
1224            var.shared_root.load().as_ref().as_ref(),
1225            Some(SharedValue::Long(7))
1226        ));
1227        assert_eq!(var.deref(), Some(Value::Long(7)));
1228        assert_eq!(var.deref_shared(), Some(Value::Long(7)));
1229    }
1230
1231    #[test]
1232    fn bind_nonpromotable_clears_shared_root() {
1233        let var = Var::new("user", "f");
1234        var.bind(Value::Long(1));
1235        assert!(var.shared_root.load().is_some());
1236        // Rebinding to a non-promotable value clears the mirror, but the
1237        // isolate-local fast path still holds it.
1238        let f = Value::NativeFunction(GcPtr::new(NativeFn::new("f", Arity::Fixed(0), |_| {
1239            Ok(Value::Nil)
1240        })));
1241        var.bind(f);
1242        assert!(var.shared_root.load().is_none());
1243        assert!(var.is_bound());
1244        assert_eq!(var.deref_shared(), None);
1245    }
1246
1247    #[test]
1248    fn from_shared_root_seeds_local_slot() {
1249        let src = Var::new("user", "y");
1250        src.bind(Value::Long(99));
1251        let recv = Var::from_shared_root("user", "y", false, src.shared_root.clone());
1252        assert_eq!(recv.deref(), Some(Value::Long(99)));
1253        // Same underlying cell.
1254        src.bind(Value::Long(100));
1255        assert_eq!(recv.deref_shared(), Some(Value::Long(100)));
1256    }
1257}