cljrs_runtime/env/env.rs
1//! Lexical environment: local frames, global namespace table, and current Env.
2
3use std::collections::{HashMap, HashSet};
4use std::sync::atomic::{AtomicBool, AtomicU8, Ordering};
5use std::sync::{Arc, Condvar, Mutex, RwLock};
6
7use crate::env::async_hook::AsyncRuntime;
8
9use crate::env::error::EvalResult;
10use crate::mode::{ExecutionMode, TierState};
11use cljrs_gc::{GcConfig, GcPtr};
12use cljrs_reader::Form;
13use cljrs_value::{CljxFn, Keyword, Namespace, ReferClojureFilter, Value, Var};
14// ── RequireSpec / RequireRefer ─────────────────────────────────────────────────
15
16/// How symbols should be referred into the requiring namespace.
17#[derive(Debug, Clone)]
18pub enum RequireRefer {
19 None,
20 All,
21 Named(Vec<Arc<str>>),
22}
23
24/// A parsed `require` specification.
25#[derive(Debug, Clone)]
26pub struct RequireSpec {
27 pub ns: Arc<str>,
28 /// Present when the namespace symbol carried a `@<hash>` version suffix.
29 pub version: Option<Arc<str>>,
30 pub alias: Option<Arc<str>>,
31 pub refer: RequireRefer,
32}
33
34// ── Frame ─────────────────────────────────────────────────────────────────────
35
36/// One stack frame of local bindings (a single `let*`, `fn`, or `loop*` scope).
37pub struct Frame {
38 pub bindings: Vec<(Arc<str>, Value)>,
39}
40
41impl Default for Frame {
42 fn default() -> Self {
43 Self::new()
44 }
45}
46
47impl Frame {
48 pub fn new() -> Self {
49 Self {
50 bindings: Vec::new(),
51 }
52 }
53
54 pub fn bind(&mut self, name: Arc<str>, val: Value) {
55 // Shadow: push new binding; lookup searches from the end.
56 self.bindings.push((name, val));
57 }
58
59 pub fn lookup(&self, name: &str) -> Option<&Value> {
60 // Search in reverse order so later bindings shadow earlier ones.
61 tracing::trace!(target: "env", "lookup {}", name);
62 for (n, v) in self.bindings.iter().rev() {
63 if n.as_ref() == name {
64 return Some(v);
65 }
66 }
67 None
68 }
69}
70
71// ── GlobalEnv ─────────────────────────────────────────────────────────────────
72
73/// The global mutable store of all namespaces.
74pub struct GlobalEnv {
75 /// Process-unique identity of this runtime instance.
76 ///
77 /// Allocated from a counter, not derived from the `Arc`'s address: an
78 /// address is only unique while the allocation is live, so a dropped
79 /// runtime could hand its key to the next one and let it inherit stale
80 /// cross-defn IR. Used to scope per-instance registries.
81 id: u64,
82 pub namespaces: RwLock<HashMap<Arc<str>, GcPtr<Namespace>>>,
83 /// Directories to search when resolving namespace names to files.
84 pub source_paths: RwLock<Vec<std::path::PathBuf>>,
85 /// Namespaces that have been fully loaded from a file (idempotent guard).
86 pub loaded: Mutex<std::collections::HashSet<Arc<str>>>,
87 /// Namespaces currently being loaded, mapped to the thread loading them.
88 /// Used to detect true circular requires (same thread) vs concurrent loads
89 /// (different thread — those wait on `loading_done` instead of erroring).
90 pub loading: Mutex<HashMap<Arc<str>, std::thread::ThreadId>>,
91 /// Signalled whenever a namespace finishes loading (or fails).
92 pub loading_done: Condvar,
93 /// Built-in namespace sources embedded in the binary.
94 /// Checked by `load_ns` before falling back to source-path search.
95 pub builtin_sources: RwLock<HashMap<Arc<str>, &'static str>>,
96 /// GC configuration for automatic collection based on memory pressure.
97 pub gc_config: RwLock<Option<Arc<GcConfig>>>,
98 /// How this runtime executes function calls. Fixed when the runtime is
99 /// built; see [`crate::RuntimeBuilder::execution_mode`].
100 execution_mode: ExecutionMode,
101 /// Which tiers are live right now (see [`TierState`]). Starts at
102 /// [`TierState::TreeWalk`] — nothing can be lowered until `clojure.core`
103 /// exists — and is raised once to `execution_mode.target_tier()` when the
104 /// builder finishes bootstrapping.
105 tier_state: AtomicU8,
106 /// This runtime's Tier-1 and Tier-2 state: the lowered-IR cache, the JIT
107 /// counters and native-code tables, and the JIT backend attached to this
108 /// runtime. Instance state: two runtimes in one process never read,
109 /// evict, or invalidate each other's entries, and everything dies with
110 /// the runtime.
111 tiers: Arc<crate::tiered::tiers::Tiers>,
112 /// Optional async runtime registered by `cljrs-async`.
113 /// `None` when the library is not linked; `Some` after `cljrs_async::init`.
114 pub async_rt: RwLock<Option<Arc<dyn AsyncRuntime>>>,
115 /// Cache of values resolved at a specific commit.
116 /// Key format: `"<ns>/<name>@<commit>"` for individual vars,
117 /// or `"<ns>@<commit>"` for whole versioned namespaces.
118 pub version_cache: Mutex<HashMap<Arc<str>, Value>>,
119 /// Parsed `cljrs.edn` config, loaded once at startup.
120 pub deps_config: RwLock<Option<Arc<cljrs_project::config::DepsConfig>>>,
121 /// When true, every versioned-symbol or versioned-namespace resolution must
122 /// carry a valid commit signature (verified natively against `trusted_keys`)
123 /// before the historical code is executed. Off by default; enabled via
124 /// `--verify-commit-signatures` CLI flag or `:verify-commit-signatures true`
125 /// in `cljrs.edn`.
126 pub verify_commit_signatures: AtomicBool,
127 /// The git backend used by versioned resolution and signature checking, or
128 /// `None` in builds that carry no VCS implementation (wasm, or
129 /// `cljrs-runtime` without its default `deps` feature). With no provider,
130 /// source files are treated as living outside any repository and versioned
131 /// resolution can only use embedded (AOT) sources. See [`crate::env::vcs`].
132 vcs: RwLock<Option<Arc<dyn crate::env::vcs::VcsProvider>>>,
133 /// Session-scoped cache of commits that have already passed signature
134 /// verification this run, keyed by `(repo_root, commit_hash)`.
135 pub sig_verify_cache: Mutex<HashSet<(Arc<str>, Arc<str>)>>,
136 /// Pinned source texts fetched from git this session, keyed by
137 /// `"<ns>@<commit>"`. The AOT compiler embeds these in the produced
138 /// binary so versioned namespaces resolve without git at runtime.
139 pub versioned_sources: RwLock<HashMap<Arc<str>, Arc<str>>>,
140 /// When true (set by AOT harness main), versioned namespaces resolve
141 /// only from embedded builtin sources — never from git. A versioned
142 /// namespace that was not embedded at compile time fails with a clear
143 /// error instead of attempting a fetch.
144 pub versioned_offline: AtomicBool,
145 /// Provenance of native (Rust-backed) packages recorded at registration:
146 /// namespace → the git commit the package was built from. Consulted by
147 /// the versioned resolver's native HEAD fallback to detect pinned-commit
148 /// mismatches.
149 pub native_provenance: RwLock<HashMap<Arc<str>, Arc<str>>>,
150 /// When true, a pinned lookup of a native function whose recorded
151 /// provenance does not match the requested commit is an error instead of
152 /// a once-per-pin warning. CLI: `--enforce-native-versions`; cljrs.edn:
153 /// `:enforce-native-versions true`.
154 pub enforce_native_versions: AtomicBool,
155 /// Pinned-native mismatches already warned about this session
156 /// (key: `"<ns>@<commit>"`), so each pin warns at most once.
157 pub provenance_warned: Mutex<HashSet<Arc<str>>>,
158 /// Optional loader for **pinned native packages** (`:rust/load :dylib`),
159 /// installed by the CLI. Called by the versioned resolver with
160 /// `(globals, base_ns, commit)` before falling back to the HEAD native
161 /// binding; returns `Ok(true)` when it registered the package's pinned
162 /// implementations into the `"<base_ns>@<commit>"` namespace.
163 #[allow(clippy::type_complexity)]
164 pub pinned_native_loader: RwLock<Option<PinnedNativeLoader>>,
165 /// Optional loader for **native dependencies on the plain `require` path**
166 /// (`:rust/load :dylib`), installed by the CLI. Called by the
167 /// unversioned namespace loader with `(globals, ns)` when a `require`d
168 /// namespace has no Clojure source on the source path; returns `Ok(true)`
169 /// when it built the dep's crate at the pinned `:git/sha` and registered
170 /// the package's exports into the **unversioned** namespace, so a plain
171 /// `(require '[my.native.lib :as lib])` brings the native code in.
172 #[allow(clippy::type_complexity)]
173 pub native_require_loader: RwLock<Option<NativeRequireLoader>>,
174 /// Loaders for **AOT-compiled namespaces**, installed by the binary
175 /// produced by `cljrs compile`. Keyed by namespace name. When a plain
176 /// `require` resolves a namespace that has a registered loader, `load_ns`
177 /// invokes the loader instead of interpreting Clojure source: the loader
178 /// evaluates the namespace's small interpreted preamble (its `ns`/`require`
179 /// and macro definitions) and then calls the namespace's natively compiled
180 /// initializer, so the bulk of the namespace runs as machine code rather
181 /// than being tree-walked at startup.
182 #[allow(clippy::type_complexity)]
183 pub compiled_ns_loaders: RwLock<HashMap<Arc<str>, CompiledNsLoader>>,
184}
185
186/// Loader callback for an AOT-compiled namespace (see
187/// `GlobalEnv::compiled_ns_loaders`). Given the global env, it loads the
188/// namespace by running its interpreted preamble and its compiled initializer.
189pub type CompiledNsLoader = Arc<dyn Fn(&Arc<GlobalEnv>) -> EvalResult<()> + Send + Sync>;
190
191/// Loader callback for pinned native packages (see
192/// `GlobalEnv::pinned_native_loader`).
193pub type PinnedNativeLoader =
194 Arc<dyn Fn(&Arc<GlobalEnv>, &str, &str) -> EvalResult<bool> + Send + Sync>;
195
196/// Loader callback for native dependencies reached through a plain `require`
197/// (see `GlobalEnv::native_require_loader`).
198pub type NativeRequireLoader = Arc<dyn Fn(&Arc<GlobalEnv>, &str) -> EvalResult<bool> + Send + Sync>;
199
200/// Source of [`GlobalEnv::id`] values.
201static NEXT_GLOBAL_ENV_ID: std::sync::atomic::AtomicU64 = std::sync::atomic::AtomicU64::new(1);
202
203impl std::fmt::Debug for GlobalEnv {
204 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
205 write!(f, "GlobalEnv {{ ... }}")
206 }
207}
208
209impl GlobalEnv {
210 pub(crate) fn var_is_private(var: &Var) -> bool {
211 matches!(
212 var.get_meta(),
213 Some(Value::Map(meta))
214 if matches!(
215 meta.get(&Value::keyword(Keyword::simple("private"))),
216 Some(Value::Bool(true))
217 )
218 )
219 }
220
221 /// Create an empty global environment for the given execution mode.
222 ///
223 /// This is the *raw* constructor: no builtins, no bootstrap, no source
224 /// paths. Use [`crate::Runtime::builder`] unless you are the builder.
225 pub fn new(execution_mode: ExecutionMode) -> Arc<Self> {
226 let id = NEXT_GLOBAL_ENV_ID.fetch_add(1, Ordering::Relaxed);
227 Arc::new(Self {
228 id,
229 namespaces: RwLock::new(HashMap::new()),
230 source_paths: RwLock::new(Vec::new()),
231 loaded: Mutex::new(std::collections::HashSet::new()),
232 loading: Mutex::new(HashMap::new()),
233 loading_done: Condvar::new(),
234 builtin_sources: RwLock::new(HashMap::new()),
235 gc_config: RwLock::new(None),
236 execution_mode,
237 tier_state: AtomicU8::new(TierState::TreeWalk as u8),
238 tiers: crate::tiered::tiers::Tiers::new(id),
239 async_rt: RwLock::new(None),
240 version_cache: Mutex::new(HashMap::new()),
241 deps_config: RwLock::new(None),
242 verify_commit_signatures: AtomicBool::new(false),
243 vcs: RwLock::new(crate::env::vcs::default_provider()),
244 sig_verify_cache: Mutex::new(HashSet::new()),
245 versioned_sources: RwLock::new(HashMap::new()),
246 versioned_offline: AtomicBool::new(false),
247 native_provenance: RwLock::new(HashMap::new()),
248 enforce_native_versions: AtomicBool::new(false),
249 provenance_warned: Mutex::new(HashSet::new()),
250 pinned_native_loader: RwLock::new(None),
251 native_require_loader: RwLock::new(None),
252 compiled_ns_loaders: RwLock::new(HashMap::new()),
253 })
254 }
255
256 /// Replace the source path list.
257 pub fn set_source_paths(&self, paths: Vec<std::path::PathBuf>) {
258 *self.source_paths.write().unwrap() = paths;
259 }
260
261 /// Register an embedded namespace source (called by cljrs-stdlib at startup).
262 pub fn register_builtin_source(&self, ns: &str, src: &'static str) {
263 self.builtin_sources
264 .write()
265 .unwrap()
266 .insert(Arc::from(ns), src);
267 }
268
269 /// Look up an embedded source for a namespace, if one has been registered.
270 pub fn builtin_source(&self, ns: &str) -> Option<&'static str> {
271 self.builtin_sources.read().unwrap().get(ns).copied()
272 }
273
274 /// Register a loader for an AOT-compiled namespace (called by the harness
275 /// `main` of a binary produced by `cljrs compile`).
276 pub fn register_compiled_ns_loader(&self, ns: &str, loader: CompiledNsLoader) {
277 self.compiled_ns_loaders
278 .write()
279 .unwrap()
280 .insert(Arc::from(ns), loader);
281 }
282
283 /// Look up the loader for an AOT-compiled namespace, if one is registered.
284 pub fn compiled_ns_loader(&self, ns: &str) -> Option<CompiledNsLoader> {
285 self.compiled_ns_loaders.read().unwrap().get(ns).cloned()
286 }
287
288 /// Mark a namespace as fully loaded from a file.
289 pub fn mark_loaded(&self, ns: &str) {
290 self.loaded.lock().unwrap().insert(Arc::from(ns));
291 }
292
293 /// True if the namespace has already been loaded from a file.
294 pub fn is_loaded(&self, ns: &str) -> bool {
295 self.loaded.lock().unwrap().contains(ns)
296 }
297
298 /// Set the GC configuration for automatic memory pressure management.
299 pub fn set_gc_config(&self, config: Arc<GcConfig>) {
300 *self.gc_config.write().unwrap() = Some(config);
301 }
302
303 /// Get the GC configuration, if one has been set.
304 pub fn gc_config(&self) -> Option<Arc<GcConfig>> {
305 self.gc_config.read().unwrap().clone()
306 }
307
308 /// Resolve a short alias to a full namespace name in `current_ns`.
309 pub fn resolve_alias(&self, current_ns: &str, alias: &str) -> Option<Arc<str>> {
310 let map = self.namespaces.read().unwrap();
311 let ns = map.get(current_ns)?;
312 let aliases = ns.get().aliases.lock().unwrap();
313 aliases.get(alias).cloned()
314 }
315
316 /// Resolve an auto-resolved keyword name (the text after `::`) to its
317 /// fully-qualified `ns/name` form.
318 ///
319 /// `::kw` qualifies with `current_ns` directly; `::alias/kw` looks
320 /// `alias` up in `current_ns`'s alias table (populated by `(require
321 /// '[... :as alias])`) and qualifies with the resolved namespace.
322 pub fn resolve_auto_keyword(&self, current_ns: &str, name: &str) -> Result<String, String> {
323 match name.split_once('/') {
324 Some((alias, kw_name)) => match self.resolve_alias(current_ns, alias) {
325 Some(ns) => Ok(format!("{ns}/{kw_name}")),
326 None => Err(format!(
327 "invalid token: ::{name} (no such namespace alias: {alias})"
328 )),
329 },
330 None => Ok(format!("{current_ns}/{name}")),
331 }
332 }
333
334 /// Return the namespace with this name, creating it if it doesn't exist.
335 pub fn get_or_create_ns(&self, name: &str) -> GcPtr<Namespace> {
336 // Fast path: already exists.
337 {
338 let map = self.namespaces.read().unwrap();
339 if let Some(ns) = map.get(name) {
340 return ns.clone();
341 }
342 }
343 // Slow path: insert.
344 let mut map = self.namespaces.write().unwrap();
345 // Re-check after acquiring write lock.
346 if let Some(ns) = map.get(name) {
347 return ns.clone();
348 }
349 let ns = GcPtr::new(Namespace::new(name));
350 map.insert(Arc::from(name), ns.clone());
351 ns
352 }
353
354 /// Intern `name` with `val` in the given namespace, returning the Var.
355 pub fn intern(&self, ns_name: &str, name: Arc<str>, val: Value) -> GcPtr<Var> {
356 let ns = self.get_or_create_ns(ns_name);
357 let mut interns = ns.get().interns.lock().unwrap();
358 if let Some(var) = interns.get(&name) {
359 // Update existing var.
360 var.get().bind(val);
361 return var.clone();
362 }
363 let var = GcPtr::new(Var::new(ns_name, name.as_ref()));
364 var.get().bind(val);
365 interns.insert(name, var.clone());
366 var
367 }
368
369 /// Look up a Var in the named namespace (interns only).
370 pub fn lookup_var(&self, ns_name: &str, sym_name: &str) -> Option<GcPtr<Var>> {
371 let map = self.namespaces.read().unwrap();
372 let ns = map.get(ns_name)?;
373 let interns = ns.get().interns.lock().unwrap();
374 interns.get(sym_name).cloned()
375 }
376
377 /// Look up a value in `ns_name`: checks interns then refers.
378 /// Routes through the dynamic binding stack so `binding` overrides work.
379 pub fn lookup_in_ns(&self, ns_name: &str, sym_name: &str) -> Option<Value> {
380 let map = self.namespaces.read().unwrap();
381 let ns = map.get(ns_name)?;
382 let ns_ref = ns.get();
383 // Check interns first.
384 {
385 let interns = ns_ref.interns.lock().unwrap();
386 if let Some(var) = interns.get(sym_name) {
387 return crate::env::dynamics::deref_var(var);
388 }
389 }
390 // Then refers.
391 {
392 let refers = ns_ref.refers.lock().unwrap();
393 if let Some(var) = refers.get(sym_name) {
394 return crate::env::dynamics::deref_var(var);
395 }
396 }
397 None
398 }
399
400 /// Look up the raw Var (not its value) in `ns_name`: interns then refers.
401 pub fn lookup_var_in_ns(&self, ns_name: &str, sym_name: &str) -> Option<GcPtr<Var>> {
402 let map = self.namespaces.read().unwrap();
403 let ns = map.get(ns_name)?;
404 let ns_ref = ns.get();
405 {
406 let interns = ns_ref.interns.lock().unwrap();
407 if let Some(var) = interns.get(sym_name) {
408 return Some(var.clone());
409 }
410 }
411 {
412 let refers = ns_ref.refers.lock().unwrap();
413 if let Some(var) = refers.get(sym_name) {
414 return Some(var.clone());
415 }
416 }
417 None
418 }
419
420 /// Copy all interns from `src_ns` into `dst_ns` as refers.
421 ///
422 /// This is the *explicit* refer — `(:require [x :refer :all])` — so it is
423 /// never narrowed by `dst_ns`'s `(:refer-clojure ...)` filter, matching
424 /// `clojure.core/refer`: naming a namespace explicitly re-maps even names
425 /// an earlier `refer-clojure` left out. The automatic core refer every
426 /// namespace starts with goes through [`GlobalEnv::refer_core`] instead.
427 pub fn refer_all(&self, dst_ns: &str, src_ns: &str) {
428 let map = self.namespaces.read().unwrap();
429 let src = match map.get(src_ns) {
430 Some(ns) => ns.clone(),
431 None => return,
432 };
433 let dst = match map.get(dst_ns) {
434 Some(ns) => ns.clone(),
435 None => return,
436 };
437 let src_interns = src.get().interns.lock().unwrap();
438 let mut dst_refers = dst.get().refers.lock().unwrap();
439 for (name, var) in src_interns.iter() {
440 if Self::var_is_private(var.get()) {
441 continue;
442 }
443 dst_refers.insert(name.clone(), var.clone());
444 }
445 }
446
447 /// Apply the automatic `clojure.core` refer that every namespace starts
448 /// with, narrowed by `dst_ns`'s `(:refer-clojure ...)` filter.
449 pub fn refer_core(&self, dst_ns: &str) {
450 self.refer_core_impl(dst_ns, false);
451 }
452
453 /// `replace`: drop the refers `dst_ns` already inherited from
454 /// `clojure.core` before re-referring, under the same lock — so installing
455 /// a filter after the namespace was pre-referred neither leaves stale
456 /// names behind nor exposes a window where core is only half-referred.
457 fn refer_core_impl(&self, dst_ns: &str, replace: bool) {
458 let map = self.namespaces.read().unwrap();
459 let src = match map.get("clojure.core") {
460 Some(ns) => ns.clone(),
461 None => return,
462 };
463 let dst = match map.get(dst_ns) {
464 Some(ns) => ns.clone(),
465 None => return,
466 };
467 // Lock order is filter → src interns → dst refers throughout.
468 let filter = dst.get().refer_clojure_filter.lock().unwrap();
469 let src_interns = src.get().interns.lock().unwrap();
470 let mut dst_refers = dst.get().refers.lock().unwrap();
471 if replace {
472 dst_refers.retain(|_, var| var.get().namespace.as_ref() != "clojure.core");
473 }
474 match filter.as_ref() {
475 Some(f) => {
476 for (name, var) in src_interns.iter() {
477 if Self::var_is_private(var.get()) {
478 continue;
479 }
480 if let Some(local) = f.local_name(name) {
481 dst_refers.insert(local, var.clone());
482 }
483 }
484 }
485 None => {
486 for (name, var) in src_interns.iter() {
487 if Self::var_is_private(var.get()) {
488 continue;
489 }
490 dst_refers.insert(name.clone(), var.clone());
491 }
492 }
493 }
494 }
495
496 /// Install `dst_ns`'s `(:refer-clojure ...)` filter (`None` removes any
497 /// previous one) and re-apply the automatic `clojure.core` refer under it.
498 ///
499 /// Refers already inherited from `clojure.core` are dropped first, so a
500 /// filter set after the namespace was pre-referred — the loader refers core
501 /// before it reads the file, and `ns` itself refers core before it reaches
502 /// the clause — still takes effect.
503 pub fn set_refer_clojure_filter(
504 &self,
505 dst_ns: &str,
506 filter: Option<ReferClojureFilter>,
507 ) -> Result<(), String> {
508 if let Some(f) = &filter {
509 self.validate_refer_clojure_filter(f)?;
510 }
511 let dst = self.get_or_create_ns(dst_ns);
512 {
513 let mut slot = dst.get().refer_clojure_filter.lock().unwrap();
514 // Nothing to install and nothing to undo: leave the refers alone.
515 if slot.is_none() && filter.is_none() {
516 return Ok(());
517 }
518 *slot = filter;
519 }
520 self.refer_core_impl(dst_ns, true);
521 Ok(())
522 }
523
524 /// Check a `(:refer-clojure ...)` filter against the names `clojure.core`
525 /// actually publishes, so a typo fails at the `ns` form rather than as an
526 /// unbound symbol somewhere further down the file.
527 ///
528 /// `:only` and `:rename` name specific vars and must resolve; `:exclude` is
529 /// subtractive and stays permissive (excluding a name core does not have is
530 /// harmless, and lets a file stay portable across core versions). Clojure
531 /// validates `:only` the same way but ignores an unresolvable `:rename`
532 /// key, since it only consults the rename map for names already in its
533 /// to-do list.
534 ///
535 /// Two names landing on the same local name is an error rather than a coin
536 /// flip: with `:rename {inc str}` both `inc` and core's own `str` want the
537 /// name `str`. Clojure warns and lets whichever one its intern table
538 /// yields last win; picking a winner by hash order here would make the
539 /// choice unstable from run to run.
540 fn validate_refer_clojure_filter(&self, filter: &ReferClojureFilter) -> Result<(), String> {
541 let map = self.namespaces.read().unwrap();
542 let Some(core) = map.get("clojure.core").cloned() else {
543 return Ok(());
544 };
545 drop(map);
546 let interns = core.get().interns.lock().unwrap();
547 // A runtime built without the core bootstrap has nothing to check
548 // against; do not fail every name.
549 if interns.is_empty() {
550 return Ok(());
551 }
552
553 for (opt, names) in [
554 ("only", filter.only.iter().flatten().collect::<Vec<_>>()),
555 ("rename", filter.rename.keys().collect::<Vec<_>>()),
556 ] {
557 let mut unknown: Vec<&str> = names
558 .into_iter()
559 .filter(|n| !interns.contains_key(*n))
560 .map(|n| n.as_ref())
561 .collect();
562 if !unknown.is_empty() {
563 unknown.sort_unstable();
564 return Err(format!(
565 ":refer-clojure :{opt} names {}, which clojure.core does not define",
566 unknown.join(", ")
567 ));
568 }
569 }
570
571 // local name → the core name referred under it.
572 let mut taken: HashMap<Arc<str>, Arc<str>> = HashMap::new();
573 let mut conflicts: Vec<(Arc<str>, Arc<str>, Arc<str>)> = Vec::new();
574 for name in interns.keys() {
575 let Some(local) = filter.local_name(name) else {
576 continue;
577 };
578 if let Some(prev) = taken.insert(local.clone(), name.clone()) {
579 let (a, b) = if prev.as_ref() <= name.as_ref() {
580 (prev, name.clone())
581 } else {
582 (name.clone(), prev)
583 };
584 conflicts.push((local, a, b));
585 }
586 }
587 if !conflicts.is_empty() {
588 conflicts.sort_unstable();
589 let (local, a, b) = &conflicts[0];
590 return Err(format!(
591 ":refer-clojure would refer both {a} and {b} as {local}; \
592 rename or exclude one of them"
593 ));
594 }
595 Ok(())
596 }
597
598 /// Names `ns_name` resolves to something other than `clojure.core`'s var
599 /// of the same name — what the IR lowerer must not inline as a builtin.
600 ///
601 /// Three things put a name in here: a `def` in `ns_name` itself, a refer
602 /// of that name from another namespace (or of a *different* core name
603 /// under it, via `:rename`), and a `(:refer-clojure ...)` filter that
604 /// leaves the name out of the automatic core refer. In each case an
605 /// unqualified call resolves to something that is not `clojure.core/name`
606 /// — or to nothing at all — and the tree-walking interpreter calls that,
607 /// so the lowered call site has to as well (issue #337).
608 ///
609 /// A name absent from the namespace's tables is *not* reported: with no
610 /// evidence to the contrary the lowerer keeps assuming core, which is what
611 /// the automatic core refer makes true for the overwhelming majority of
612 /// call sites (and keeps the lowerer's synthetic names, e.g. `case=`,
613 /// working in namespaces whose refers are not populated yet).
614 pub fn core_shadowed_names(&self, ns_name: &str) -> HashSet<Arc<str>> {
615 let mut out: HashSet<Arc<str>> = HashSet::new();
616 let (ns, core) = {
617 let map = self.namespaces.read().unwrap();
618 match map.get(ns_name) {
619 Some(ns) => (ns.clone(), map.get("clojure.core").cloned()),
620 None => return out,
621 }
622 };
623 let ns_ref = ns.get();
624
625 // A var bound here is core's only if it *is* core's var under its own
626 // name; core's own namespace passes this trivially for its interns.
627 let shadows = |name: &Arc<str>, var: &GcPtr<Var>| {
628 let v = var.get();
629 v.namespace.as_ref() != "clojure.core" || v.name != *name
630 };
631 for table in [&ns_ref.interns, &ns_ref.refers] {
632 let entries = table.lock().unwrap();
633 for (name, var) in entries.iter() {
634 if shadows(name, var) {
635 out.insert(name.clone());
636 }
637 }
638 }
639
640 // Names the `(:refer-clojure ...)` filter kept out of the automatic
641 // refer: nothing binds them here, so they are not core's either.
642 // Lock order is filter → core interns, as in `refer_core_impl`.
643 let filter = ns_ref.refer_clojure_filter.lock().unwrap();
644 if let (Some(filter), Some(core)) = (filter.as_ref(), core) {
645 let interns = core.get().interns.lock().unwrap();
646 for name in interns.keys() {
647 if filter.local_name(name).as_ref() != Some(name) {
648 out.insert(name.clone());
649 }
650 }
651 }
652 out
653 }
654
655 /// Copy selected interns from `src_ns` into `dst_ns` as refers.
656 pub fn refer_named(&self, dst_ns: &str, src_ns: &str, names: &[Arc<str>]) {
657 let map = self.namespaces.read().unwrap();
658 let src = match map.get(src_ns) {
659 Some(ns) => ns.clone(),
660 None => return,
661 };
662 let dst = match map.get(dst_ns) {
663 Some(ns) => ns.clone(),
664 None => return,
665 };
666 let src_interns = src.get().interns.lock().unwrap();
667 let mut dst_refers = dst.get().refers.lock().unwrap();
668 for name in names {
669 if let Some(var) = src_interns.get(name) {
670 // Private vars are never referable, whether selected by
671 // `:refer :all` or named explicitly with `:refer [name]`.
672 if Self::var_is_private(var.get()) {
673 continue;
674 }
675 // Use insert (not or_insert_with) so that an explicit
676 // `require :refer [name]` always overrides a previous refer
677 // (e.g. one inherited from clojure.core via refer-all).
678 // clojure.core.async's `into` intentionally shadows clojure.core/into;
679 // or_insert_with would silently drop the override.
680 dst_refers.insert(name.clone(), var.clone());
681 }
682 }
683 }
684
685 /// Register `alias` → `full_ns` in `current_ns`'s alias table.
686 pub fn add_alias(&self, current_ns: &str, alias: &str, full_ns: &str) {
687 let ns_ptr = self.get_or_create_ns(current_ns);
688 let mut aliases = ns_ptr.get().aliases.lock().unwrap();
689 aliases.insert(Arc::from(alias), Arc::from(full_ns));
690 }
691
692 /// Process-unique identity of this runtime instance.
693 #[inline(always)]
694 pub fn id(&self) -> u64 {
695 self.id
696 }
697
698 /// This runtime's Tier-1/Tier-2 state.
699 #[inline(always)]
700 pub fn tiers(&self) -> &Arc<crate::tiered::tiers::Tiers> {
701 &self.tiers
702 }
703
704 /// This runtime's cache of lowered IR.
705 #[inline(always)]
706 pub fn ir_cache(&self) -> &crate::tiered::ir_cache::IrCache {
707 self.tiers.ir_cache()
708 }
709
710 /// This runtime's JIT counters, profiles, and native-code tables.
711 #[inline(always)]
712 pub fn jit(&self) -> &crate::tiered::jit_state::JitState {
713 self.tiers.jit()
714 }
715
716 /// The JIT compiler attached to this runtime, if any.
717 ///
718 /// `None` when no JIT is linked or installed; callers then keep to the
719 /// interpreter tiers. Installed by `cljrs_compiler::jit::install`.
720 #[inline(always)]
721 pub fn jit_backend(&self) -> Option<Arc<dyn crate::tiered::backend::JitBackend>> {
722 self.tiers.jit().backend().cloned()
723 }
724
725 // ── Execution mode and tier state ────────────────────────────────────
726
727 /// How this runtime executes function calls.
728 #[inline(always)]
729 pub fn execution_mode(&self) -> ExecutionMode {
730 self.execution_mode
731 }
732
733 /// Which tiers are live right now.
734 #[inline(always)]
735 pub fn tier_state(&self) -> TierState {
736 TierState::from_u8(self.tier_state.load(Ordering::Acquire))
737 }
738
739 /// Raise the live tier state. Called once by the runtime builder after
740 /// the bootstrap completes; lowering the tier is not supported, so a
741 /// request below the current state is ignored.
742 pub fn set_tier_state(&self, tier: TierState) {
743 let _ = self.tier_state.fetch_max(tier as u8, Ordering::AcqRel);
744 }
745
746 /// True when IR may be lowered, cached, and interpreted. This is the
747 /// gate the old `compiler_ready` flag served.
748 #[inline(always)]
749 pub fn ir_enabled(&self) -> bool {
750 self.tier_state().ir_enabled()
751 }
752
753 // ── Evaluation entry points ──────────────────────────────────────────
754
755 /// Evaluate `form` in `env`.
756 #[inline(always)]
757 pub fn eval(&self, form: &Form, env: &mut Env) -> EvalResult {
758 crate::interp::eval::eval(form, env)
759 }
760
761 /// Call a Clojure function, taking the path this runtime's
762 /// [`ExecutionMode`] selects.
763 ///
764 /// This is the single function-call dispatch point: tree walk, tier-1 IR,
765 /// and JIT-native execution are all reached from here.
766 #[inline(always)]
767 pub fn call_cljrs_fn(&self, func: &CljxFn, args: &[Value], env: &mut Env) -> EvalResult {
768 match self.execution_mode {
769 ExecutionMode::TreeWalk => crate::interp::apply::call_cljrs_fn(func, args, env),
770 ExecutionMode::Tiered | ExecutionMode::TieredNoJit => {
771 crate::tiered::apply::call_cljrs_fn(func, args, env)
772 }
773 ExecutionMode::NoGcTransaction => crate::env::depth::call_cljrs_fn(func, args, env),
774 }
775 }
776
777 /// Notify the active tier that a new `fn*` was defined.
778 ///
779 /// In a tiered runtime with IR enabled this eagerly lowers the function
780 /// (when eager lowering is on); in every other mode it does nothing.
781 #[inline(always)]
782 pub fn on_fn_defined(&self, f: &CljxFn, env: &mut Env) {
783 if self.execution_mode.is_tiered() && self.ir_enabled() {
784 crate::tiered::ir_interp::eager_lower_fn(f, env);
785 }
786 }
787
788 /// Install an async runtime. Called once by `cljrs_async::init`.
789 /// Subsequent calls are silently ignored (first writer wins).
790 pub fn set_async_runtime(&self, rt: Arc<dyn AsyncRuntime>) {
791 let mut guard = self.async_rt.write().unwrap();
792 if guard.is_none() {
793 *guard = Some(rt);
794 }
795 }
796
797 /// Return the async runtime, if one has been registered.
798 pub fn async_runtime(&self) -> Option<Arc<dyn AsyncRuntime>> {
799 self.async_rt.read().unwrap().clone()
800 }
801
802 /// Return `(source_file, git_repo_root)` for the named namespace, if
803 /// both have been populated by the loader.
804 pub fn get_ns_git_context(&self, ns_name: &str) -> Option<(Arc<str>, Arc<str>)> {
805 let map = self.namespaces.read().unwrap();
806 let ns = map.get(ns_name)?;
807 let ns_ref = ns.get();
808 let file = ns_ref.source_file.lock().unwrap().clone()?;
809 let repo = ns_ref.git_repo_root.lock().unwrap().clone()?;
810 Some((file, repo))
811 }
812
813 /// Store a resolved versioned value in the cache.
814 /// Key: `"<ns>/<name>@<commit>"`.
815 pub fn cache_versioned(&self, ns: &str, name: &str, commit: &str, val: Value) {
816 let key: Arc<str> = Arc::from(format!("{ns}/{name}@{commit}"));
817 self.version_cache.lock().unwrap().insert(key, val);
818 }
819
820 /// Retrieve a previously resolved versioned value, if cached.
821 pub fn get_cached_versioned(&self, ns: &str, name: &str, commit: &str) -> Option<Value> {
822 let key = format!("{ns}/{name}@{commit}");
823 self.version_cache
824 .lock()
825 .unwrap()
826 .get(key.as_str())
827 .cloned()
828 }
829
830 /// Mark namespace `name@commit` as loaded in the standard loaded set.
831 pub fn cache_versioned_ns(&self, ns: &str, commit: &str) {
832 let key: Arc<str> = Arc::from(format!("{ns}@{commit}"));
833 self.version_cache.lock().unwrap().insert(key, Value::Nil);
834 }
835
836 /// Record the source text of a versioned namespace fetched from git.
837 /// Key: `"<ns>@<commit>"`. Consumed by the AOT compiler for embedding.
838 pub fn record_versioned_source(&self, versioned_ns: &str, src: &str) {
839 self.versioned_sources
840 .write()
841 .unwrap()
842 .insert(Arc::from(versioned_ns), Arc::from(src));
843 }
844
845 /// Snapshot of all versioned sources fetched this session, sorted by key.
846 pub fn versioned_sources_snapshot(&self) -> Vec<(Arc<str>, Arc<str>)> {
847 let map = self.versioned_sources.read().unwrap();
848 let mut entries: Vec<_> = map.iter().map(|(k, v)| (k.clone(), v.clone())).collect();
849 entries.sort_by(|a, b| a.0.cmp(&b.0));
850 entries
851 }
852
853 /// Restrict versioned-namespace resolution to embedded builtin sources
854 /// (no git). Called by AOT harness binaries, which embed every pinned
855 /// source discovered at compile time.
856 pub fn set_versioned_offline(&self, offline: bool) {
857 self.versioned_offline.store(offline, Ordering::Relaxed);
858 }
859
860 /// True when versioned namespaces may only come from embedded sources.
861 pub fn versioned_offline(&self) -> bool {
862 self.versioned_offline.load(Ordering::Relaxed)
863 }
864
865 /// Record the git commit a native (Rust-backed) package was built from.
866 /// Called at registration time (`Registry::set_provenance` or the
867 /// `register_provenance!` inventory entry in cljrs-interop).
868 pub fn set_native_provenance(&self, ns: &str, commit: &str) {
869 self.native_provenance
870 .write()
871 .unwrap()
872 .insert(Arc::from(ns), Arc::from(commit));
873 }
874
875 /// The recorded provenance commit for a native package's namespace.
876 pub fn native_provenance_for(&self, ns: &str) -> Option<Arc<str>> {
877 self.native_provenance.read().unwrap().get(ns).cloned()
878 }
879
880 /// Make pinned-native provenance mismatches hard errors.
881 pub fn set_enforce_native_versions(&self, enforce: bool) {
882 self.enforce_native_versions
883 .store(enforce, Ordering::Relaxed);
884 }
885
886 /// True when pinned-native provenance mismatches are errors.
887 pub fn enforce_native_versions(&self) -> bool {
888 self.enforce_native_versions.load(Ordering::Relaxed)
889 }
890
891 /// Install the pinned-native package loader (called once by
892 /// `cljrs::native::pinned::install`; first writer wins).
893 pub fn set_pinned_native_loader(&self, loader: PinnedNativeLoader) {
894 let mut guard = self.pinned_native_loader.write().unwrap();
895 if guard.is_none() {
896 *guard = Some(loader);
897 }
898 }
899
900 /// Install the native-dependency `require` loader (called once by
901 /// `cljrs::native::pinned::install`; first writer wins).
902 pub fn set_native_require_loader(&self, loader: NativeRequireLoader) {
903 let mut guard = self.native_require_loader.write().unwrap();
904 if guard.is_none() {
905 *guard = Some(loader);
906 }
907 }
908
909 /// The installed VCS backend, or `None` when this build has none (see
910 /// [`crate::env::vcs`]). Callers must degrade gracefully: "no provider"
911 /// means "this source file is not in a git repository".
912 pub fn vcs(&self) -> Option<Arc<dyn crate::env::vcs::VcsProvider>> {
913 self.vcs.read().unwrap().clone()
914 }
915
916 /// Replace the VCS backend. Lets an embedder that built without the
917 /// `deps` feature supply its own git implementation, or a sandboxed host
918 /// remove the default one (`None`) so no versioned resolution can reach
919 /// the filesystem's git history.
920 ///
921 /// Drops every cached signature verdict: those were reached by the
922 /// outgoing provider, against its trust set and its view of the
923 /// repository, and say nothing about what the incoming one would decide
924 /// for the same `(repo, commit)`. Keeping them would let a permissive
925 /// provider launder an approval for source a later provider serves.
926 pub fn set_vcs_provider(&self, provider: Option<Arc<dyn crate::env::vcs::VcsProvider>>) {
927 // Neither this nor `check_commit_signature` ever holds the `vcs` and
928 // `sig_verify_cache` locks at the same time, and the two reach for
929 // them in opposite orders — keep it that way, or the pair becomes a
930 // lock-order inversion.
931 *self.vcs.write().unwrap() = provider;
932 self.invalidate_signature_cache();
933 }
934
935 /// Forget every cached signature verdict, so the next
936 /// [`check_commit_signature`](Self::check_commit_signature) re-asks the
937 /// current provider. Called whenever the thing that produced those
938 /// verdicts changes: the provider itself, or its trusted-key set.
939 pub fn invalidate_signature_cache(&self) {
940 self.sig_verify_cache.lock().unwrap().clear();
941 }
942
943 /// If `:verify-commit-signatures` is enabled, verify that `commit` inside
944 /// `repo_root` carries a valid GPG or SSH signature.
945 ///
946 /// Returns `Ok(())` immediately when the feature is off. On the happy
947 /// path the result is cached per `(repo_root, commit)` so each commit is
948 /// only verified once per session. On failure returns
949 /// `EvalError::CommitSignatureVerificationFailed`.
950 ///
951 /// If verification is demanded but this build has no VCS provider, the
952 /// check fails: silently accepting an unverifiable commit would defeat the
953 /// flag the user explicitly turned on.
954 pub fn check_commit_signature(&self, repo_root: &str, commit: &str) -> EvalResult<()> {
955 if !self.verify_commit_signatures.load(Ordering::Relaxed) {
956 return Ok(());
957 }
958 let key = (Arc::<str>::from(repo_root), Arc::<str>::from(commit));
959 if self.sig_verify_cache.lock().unwrap().contains(&key) {
960 return Ok(());
961 }
962 let Some(vcs) = self.vcs() else {
963 return Err(crate::env::error::EvalError::Runtime(format!(
964 "commit-signature verification is enabled, but this build has no VCS \
965 provider to verify commit {commit} with (cljrs-runtime built without \
966 the `deps` feature)"
967 )));
968 };
969 vcs.verify_commit_signature(std::path::Path::new(repo_root), commit)
970 .map_err(|e| match e {
971 crate::env::vcs::SignatureFailure::Untrusted { commit, reason } => {
972 crate::env::error::EvalError::CommitSignatureVerificationFailed {
973 commit,
974 reason,
975 }
976 }
977 crate::env::vcs::SignatureFailure::Error(msg) => {
978 crate::env::error::EvalError::Runtime(msg)
979 }
980 })?;
981 self.sig_verify_cache.lock().unwrap().insert(key);
982 Ok(())
983 }
984
985 /// Build the trusted-signer key set from a parsed `cljrs.edn` config and
986 /// install it, so subsequent `check_commit_signature` calls verify against
987 /// it. Inline keys are parsed directly; `File` entries are read from disk.
988 /// Returns the number of keys loaded; warns (to stderr) on any key that
989 /// fails to load rather than aborting. Returns 0 when this build has no
990 /// VCS provider, since there is nothing that could consume the keys.
991 ///
992 /// Replacing the trust set invalidates the signature cache for the same
993 /// reason replacing the provider does: a verdict reached under the old
994 /// keys is not a verdict under the new ones. (In the normal flow this
995 /// runs at session start, before anything has been verified.)
996 pub fn load_trusted_signers(&self, config: &cljrs_project::config::DepsConfig) -> usize {
997 let Some(vcs) = self.vcs() else {
998 return 0;
999 };
1000 let loaded = vcs.load_trusted_signers(&config.trusted_signers);
1001 self.invalidate_signature_cache();
1002 loaded
1003 }
1004}
1005
1006// ── Env ───────────────────────────────────────────────────────────────────────
1007
1008/// The full execution environment: a stack of local frames plus the global env.
1009pub struct Env {
1010 pub frames: Vec<Frame>,
1011 pub current_ns: Arc<str>,
1012 pub globals: Arc<GlobalEnv>,
1013 /// When set, unversioned same-namespace symbol lookups implicitly resolve
1014 /// at this commit hash instead of HEAD. Set by the versioned resolver when
1015 /// evaluating a function body fetched from git history.
1016 pub versioned_eval_commit: Option<Arc<str>>,
1017 /// True when evaluating the body of an `^:async` function.
1018 /// Set by `cljrs-async`; allows the `await` special form to know whether
1019 /// to yield (async context) or block the OS thread (sync context).
1020 pub is_async: bool,
1021}
1022
1023impl Env {
1024 pub fn new(globals: Arc<GlobalEnv>, ns: &str) -> Self {
1025 Self {
1026 frames: Vec::new(),
1027 current_ns: Arc::from(ns),
1028 globals,
1029 versioned_eval_commit: None,
1030 is_async: false,
1031 }
1032 }
1033
1034 /// Create an Env for evaluating source at a specific commit.
1035 pub fn new_versioned(globals: Arc<GlobalEnv>, ns: &str, commit: &str) -> Self {
1036 Self {
1037 versioned_eval_commit: Some(Arc::from(commit)),
1038 ..Self::new(globals, ns)
1039 }
1040 }
1041
1042 /// Create an Env pre-loaded with a function's closed-over bindings.
1043 pub fn with_closure(globals: Arc<GlobalEnv>, ns: &str, f: &CljxFn) -> Self {
1044 let mut env = Self::new(globals, ns);
1045 if !f.closed_over_names.is_empty() {
1046 env.push_frame();
1047 for (name, val) in f.closed_over_names.iter().zip(f.closed_over_vals.iter()) {
1048 env.bind(name.clone(), val.clone());
1049 }
1050 }
1051 env
1052 }
1053
1054 pub fn push_frame(&mut self) {
1055 self.frames.push(Frame::new());
1056 }
1057
1058 pub fn pop_frame(&mut self) {
1059 self.frames.pop();
1060 }
1061
1062 /// Bind `name` to `val` in the top frame.
1063 pub fn bind(&mut self, name: Arc<str>, val: Value) {
1064 if let Some(frame) = self.frames.last_mut() {
1065 frame.bind(name, val);
1066 }
1067 // If there are no frames, the binding is silently dropped.
1068 // Callers must push a frame first.
1069 }
1070
1071 /// Look up `name`: local frames (innermost first), then the current namespace.
1072 pub fn lookup(&self, name: &str) -> Option<Value> {
1073 tracing::trace!(target: "env", "lookup {} in {} frames", name, self.frames.len());
1074 for frame in self.frames.iter().rev() {
1075 if let Some(v) = frame.lookup(name) {
1076 return Some(v.clone());
1077 }
1078 }
1079 self.globals.lookup_in_ns(&self.current_ns, name)
1080 }
1081
1082 /// Look up `name` in local frames only — does **not** fall back to the
1083 /// global namespace. Used by the versioned resolver to check for local
1084 /// bindings before applying commit inheritance.
1085 pub fn lookup_local_frames(&self, name: &str) -> Option<Value> {
1086 for frame in self.frames.iter().rev() {
1087 if let Some(v) = frame.lookup(name) {
1088 return Some(v.clone());
1089 }
1090 }
1091 None
1092 }
1093
1094 /// Look up the Var object for `name` in the current namespace.
1095 pub fn lookup_var(&self, name: &str) -> Option<GcPtr<Var>> {
1096 self.globals.lookup_var_in_ns(&self.current_ns, name)
1097 }
1098
1099 /// Collect all current local bindings (all frames, innermost last).
1100 /// Used for closure capture.
1101 pub fn all_local_bindings(&self) -> (Vec<Arc<str>>, Vec<Value>) {
1102 let mut names = Vec::new();
1103 let mut vals = Vec::new();
1104 // Outermost first so inner frames override on lookup.
1105 for frame in &self.frames {
1106 for (n, v) in &frame.bindings {
1107 names.push(n.clone());
1108 vals.push(v.clone());
1109 }
1110 }
1111 (names, vals)
1112 }
1113
1114 /// Create a child Env for closure capture (same globals, same ns, captures locals).
1115 pub fn child(&self) -> Self {
1116 let (names, vals) = self.all_local_bindings();
1117 let mut child = Self::new(self.globals.clone(), &self.current_ns);
1118 child.is_async = self.is_async;
1119 if !names.is_empty() {
1120 child.push_frame();
1121 for (n, v) in names.into_iter().zip(vals) {
1122 child.bind(n, v);
1123 }
1124 }
1125 child
1126 }
1127
1128 #[inline(always)]
1129 pub fn eval(&mut self, form: &Form) -> EvalResult {
1130 let globals = self.globals.clone();
1131 globals.eval(form, self)
1132 }
1133
1134 #[inline(always)]
1135 pub fn call_cljrs_fn(&mut self, func: &CljxFn, args: &[Value]) -> EvalResult {
1136 let globals = self.globals.clone();
1137 globals.call_cljrs_fn(func, args, self)
1138 }
1139
1140 #[inline(always)]
1141 pub fn on_fn_defined(&mut self, func: &CljxFn) {
1142 let globals = self.globals.clone();
1143 globals.on_fn_defined(func, self);
1144 }
1145}