Skip to main content

harn_vm/
stdlib.rs

1//! Standard library builtins for the Harn VM.
2
3mod agent_sessions;
4pub mod agent_state;
5pub(crate) mod agents;
6mod agents_daemon;
7pub(crate) mod assemble;
8pub mod asset_paths;
9mod bytes;
10mod calendar;
11mod channel_guardrails;
12mod channels;
13pub(crate) mod clock;
14pub(crate) mod collections;
15mod command_policy;
16mod compression;
17mod concurrency;
18mod connectors;
19mod cookies;
20mod crypto;
21mod csv;
22mod datetime;
23mod durable_step;
24mod event_log;
25pub(crate) mod files;
26mod flow;
27mod fs;
28mod git;
29pub(crate) mod harn_entry;
30pub(crate) mod hitl;
31mod hitl_read;
32pub mod host;
33pub(crate) mod io;
34mod iter;
35pub(crate) mod json;
36mod json_query;
37pub(crate) mod json_stream;
38mod jsonrpc;
39mod junit;
40mod lifecycle_receipts;
41mod logging;
42pub mod long_running;
43mod math;
44pub(crate) mod memory;
45mod monitors;
46mod multipart;
47mod net_policy;
48mod oauth_dynreg;
49mod oauth_storage;
50mod observability;
51mod options;
52mod path;
53pub(crate) mod path_scope_guard;
54pub(crate) mod pool;
55mod postgres;
56pub mod process;
57mod project;
58mod project_catalog;
59mod project_enrich;
60mod regex;
61pub(crate) mod registration;
62mod review;
63mod runtime_scope;
64pub(crate) mod sandbox;
65pub mod secret_scan;
66mod sets;
67pub(crate) mod shapes;
68mod skills;
69mod strings;
70pub(crate) mod supervisor;
71pub mod template;
72mod testbench;
73mod testing;
74mod timing;
75pub mod token_redaction;
76pub(crate) mod tool_hooks;
77pub(crate) mod tools;
78pub mod tracing;
79mod transcript_compact;
80pub(crate) mod transcript_project;
81mod triggers_stdlib;
82mod tui;
83mod types;
84mod url_parse;
85mod vision;
86pub(crate) mod waitpoint;
87mod waitpoints;
88mod web;
89pub mod workflow_messages;
90mod xml;
91
92use crate::http::register_http_builtins;
93use crate::llm::{register_deferred_llm_builtins, register_llm_builtins};
94use crate::mcp::register_mcp_builtins;
95use crate::mcp_server::register_mcp_server_builtins;
96use crate::vm::Vm;
97
98pub(crate) use crate::schema::{json_to_vm_value, schema_result_value};
99pub(crate) fn set_thread_source_dir(dir: &std::path::Path) {
100    process::set_thread_source_dir(dir);
101}
102
103/// Register core builtins: pure/deterministic, no I/O.
104pub fn register_core_stdlib(vm: &mut Vm) {
105    crate::runtime_context::register_runtime_context_builtins(vm);
106    types::register_type_builtins(vm);
107    math::register_math_builtins(vm);
108    strings::register_string_builtins(vm);
109    json::register_json_builtins(vm);
110    json_stream::register_json_stream_builtins(vm);
111    xml::register_xml_builtins(vm);
112    datetime::register_datetime_builtins(vm);
113    calendar::register_calendar_builtins(vm);
114    regex::register_regex_builtins(vm);
115    bytes::register_bytes_builtins(vm);
116    compression::register_compression_builtins(vm);
117    command_policy::register_command_policy_builtins(vm);
118    runtime_scope::register_runtime_scope_builtins(vm);
119    crypto::register_crypto_builtins(vm);
120    csv::register_csv_builtins(vm);
121    junit::register_junit_builtins(vm);
122    multipart::register_multipart_builtins(vm);
123    url_parse::register_url_builtins(vm);
124    web::register_web_builtins(vm);
125    cookies::register_cookie_builtins(vm);
126    path::register_path_helper_builtins(vm);
127    sets::register_set_builtins(vm);
128    collections::register_collection_builtins(vm);
129    iter::register_iter_builtins(vm);
130    event_log::register_event_log_builtins(vm);
131    durable_step::register_durable_step_builtins(vm);
132    channels::register_channel_builtins(vm);
133    channel_guardrails::register_channel_guardrail_builtins(vm);
134    shapes::register_shape_builtins(vm);
135    testing::register_testing_builtins(vm);
136    flow::register_flow_builtins(vm);
137    lifecycle_receipts::register_lifecycle_receipt_builtins(vm);
138    net_policy::register_net_policy_builtins(vm);
139}
140
141/// Register I/O builtins (requires OS access).
142pub fn register_io_stdlib(vm: &mut Vm) {
143    io::register_io_builtins(vm);
144    host::register_host_builtins(vm);
145    fs::register_fs_builtins(vm);
146    files::register_file_builtins(vm);
147    git::register_git_builtins(vm);
148    vision::register_vision_builtins(vm);
149    agent_state::register_agent_state_builtins(vm);
150    memory::register_memory_builtins(vm);
151    process::register_process_builtins(vm);
152    process::register_path_builtins(vm);
153    sandbox::register_sandbox_builtins(vm);
154    // Clock builtins overlay process::timestamp/elapsed so they honor
155    // mock_time / advance_time. Register AFTER process to take precedence.
156    clock::register_clock_builtins(vm);
157    testbench::register_testbench_builtins(vm);
158    project::register_project_builtins(vm);
159    tracing::register_tracing_builtins(vm);
160    observability::register_observability_builtins(vm);
161    timing::register_timing_builtins(vm);
162    tui::register_tui_builtins(vm);
163}
164
165fn register_agent_stdlib_before_llm(vm: &mut Vm) {
166    concurrency::register_concurrency_builtins(vm);
167    connectors::register_connector_builtins(vm);
168    review::register_review_builtins(vm);
169    secret_scan::register_secret_scan_builtins(vm);
170    tools::register_tool_builtins(vm);
171    tool_hooks::register_tool_hooks_builtins(vm);
172    crate::composition::register_composition_builtins(vm);
173    skills::register_skill_builtins(vm);
174    agents_daemon::register_daemon_builtins(vm);
175    triggers_stdlib::register_trigger_builtins(vm);
176    postgres::register_postgres_builtins(vm);
177    waitpoints::register_waitpoint_builtins(vm);
178    monitors::register_monitor_builtins(vm);
179    hitl::register_hitl_builtins(vm);
180    hitl_read::register_hitl_read_builtins(vm);
181    waitpoint::register_waitpoint_builtins(vm);
182    supervisor::register_supervisor_builtins(vm);
183    agents::register_agent_builtins(vm);
184    pool::register_pool_builtins(vm);
185    oauth_storage::register_oauth_storage_builtins(vm);
186    oauth_dynreg::register_oauth_dynreg_builtins(vm);
187    token_redaction::register_token_redaction_builtins(vm);
188    agent_sessions::register_agent_session_builtins(vm);
189    path_scope_guard::register_path_scope_guard_builtins(vm);
190    workflow_messages::register_workflow_message_builtins(vm);
191    transcript_compact::register_transcript_compaction_builtins(vm);
192    transcript_project::register_transcript_projection_builtins(vm);
193    assemble::register_assemble_context_builtin(vm);
194    crate::egress::register_egress_builtins(vm);
195    register_http_builtins(vm);
196    jsonrpc::register_jsonrpc_builtins(vm);
197}
198
199fn register_agent_stdlib_after_llm(vm: &mut Vm) {
200    register_mcp_builtins(vm);
201    register_mcp_server_builtins(vm);
202    crate::step_runtime::register_step_builtins(vm);
203}
204
205/// Register agent builtins (requires network access and async runtime).
206pub fn register_agent_stdlib(vm: &mut Vm) {
207    register_agent_stdlib_before_llm(vm);
208    register_llm_builtins(vm);
209    register_agent_stdlib_after_llm(vm);
210}
211
212fn register_agent_stdlib_with_deferred_llm(vm: &mut Vm) {
213    register_agent_stdlib_before_llm(vm);
214    register_deferred_llm_builtins(vm);
215    register_agent_stdlib_after_llm(vm);
216}
217
218/// Register all standard builtins on a VM (core + io + agent).
219pub fn register_vm_stdlib(vm: &mut Vm) {
220    register_core_stdlib(vm);
221    register_io_stdlib(vm);
222    register_agent_stdlib(vm);
223}
224
225/// Register the stdlib shape used by latency-sensitive CLI execution.
226pub fn register_vm_stdlib_with_deferred_llm(vm: &mut Vm) {
227    register_core_stdlib(vm);
228    register_io_stdlib(vm);
229    register_agent_stdlib_with_deferred_llm(vm);
230}
231
232pub(crate) fn rebind_execution_state_builtins(vm: &mut Vm) {
233    concurrency::register_concurrency_builtins(vm);
234}
235
236fn stdlib_probe_vm() -> Vm {
237    let mut vm = Vm::new();
238    register_vm_stdlib(&mut vm);
239    // Name-only/metadata introspection never accesses this path, but passing
240    // a real per-platform temp dir keeps registration logic honest if a
241    // callee someday validates its parent.
242    let tmp = std::env::temp_dir();
243    crate::store::register_store_builtins(&mut vm, &tmp);
244    crate::checkpoint::register_checkpoint_builtins(&mut vm, &tmp, "default");
245    crate::metadata::register_metadata_builtins(&mut vm, &tmp);
246    crate::metadata::register_scan_builtins(&mut vm);
247    vm
248}
249
250/// Return the canonical list of all stdlib builtin names. Used by
251/// harn-lint and harn-lsp to avoid hardcoded duplicate lists.
252pub fn stdlib_builtin_names() -> Vec<String> {
253    let vm = stdlib_probe_vm();
254    let mut names = vm.builtin_names();
255    // Special opcodes/keywords, not registered builtins, but linter
256    // should recognize them as valid function calls.
257    for extra in [
258        "spawn",
259        "await",
260        "cancel",
261        "cancel_graceful",
262        "__signal_interrupted",
263        "__signal_off_interrupt",
264        "__signal_on_interrupt",
265        "__signal_raise",
266        "is_cancelled",
267    ] {
268        names.push(extra.to_string());
269    }
270    names
271}
272
273/// Return discoverable metadata for registered stdlib builtins.
274pub fn stdlib_builtin_metadata() -> Vec<crate::vm::VmBuiltinMetadata> {
275    stdlib_probe_vm().builtin_metadata()
276}
277
278/// Reset thread-local stdlib state. Call between test runs.
279///
280/// Note: `long_running::reset_state()` is intentionally NOT called here
281/// because that store is process-global, not thread-local. Wiping it
282/// from a per-test reset hook lets one test cancel another test's
283/// in-flight worker thread (and lose its `agent_inbox::push`
284/// notification), which surfaces as `walk_dir_long_running` /
285/// `glob_long_running` timing out under parallel test load. The two
286/// call sites that genuinely need a clean handle store —
287/// `stdlib::fs::tests::{walk_dir_long_running,glob_long_running}` — call
288/// `long_running::reset_state()` explicitly while holding
289/// `LONG_RUNNING_TEST_LOCK`.
290pub fn reset_stdlib_state() {
291    logging::reset_logging_state();
292    process::reset_process_state();
293    clock::reset_clock_state();
294    io::reset_io_state();
295    sandbox::reset_sandbox_state();
296    fs::reset_fs_state();
297    json::reset_json_state();
298    json_stream::reset_json_stream_state();
299    host::reset_host_state();
300    observability::reset_observability_state();
301    timing::reset_timing_state();
302    durable_step::reset_durable_step_state();
303    crate::egress::reset_egress_policy_for_host();
304    hitl::reset_hitl_state();
305    crate::http::reset_http_state();
306    jsonrpc::reset_jsonrpc_state();
307    monitors::reset_monitor_state();
308    waitpoints::reset_waitpoint_state();
309    waitpoint::reset_waitpoint_state();
310    triggers_stdlib::reset_auto_resume_timeouts();
311    agents::reset_agent_worker_state();
312    pool::reset_pool_state();
313    postgres::reset_postgres_state();
314    supervisor::reset_supervisor_state();
315    agents::records::reset_eval_metrics();
316    agents::records::reset_friction_events();
317    tools::clear_current_tool_registry();
318    tools::clear_tool_synthesis_cache();
319    vision::reset_vision_state();
320    crate::skills::clear_current_skill_registry();
321    template::reset_prompt_registry();
322    crate::triggers::clear_webhook_intake_state();
323    crate::llm::cache::reset_in_process_cache_state();
324}