1use std::future::Future;
2use std::sync::Arc;
3
4use crate::value::{ErrorCategory, VmBuiltinFn, VmClosure, VmError, VmValue};
5use crate::BuiltinId;
6
7use super::{
8 CallArgs, ScopeSpan, Vm, VmBuiltinArity, VmBuiltinDispatch, VmBuiltinEntry, VmBuiltinKind,
9 VmBuiltinMetadata,
10};
11
12impl Vm {
13 fn builtin_span_kind(name: &str) -> Option<crate::tracing::SpanKind> {
14 match name {
15 "llm_call" | "llm_stream" | "llm_stream_call" | "agent_loop" | "agent_turn" => {
16 Some(crate::tracing::SpanKind::LlmCall)
17 }
18 "mcp_call" => Some(crate::tracing::SpanKind::ToolCall),
19 _ => None,
20 }
21 }
22
23 fn is_runtime_context_builtin(name: &str) -> bool {
24 matches!(
25 name,
26 "runtime_context"
27 | "task_current"
28 | "runtime_context_values"
29 | "runtime_context_get"
30 | "runtime_context_set"
31 | "runtime_context_clear"
32 )
33 }
34
35 fn resolve_sync_builtin_id_or_name(
36 &self,
37 direct_id: Option<BuiltinId>,
38 name: &str,
39 ) -> Option<Result<VmBuiltinFn, VmError>> {
40 if crate::autonomy::needs_async_side_effect_enforcement(name)
41 || Self::is_runtime_context_builtin(name)
42 {
43 return None;
44 }
45
46 let dispatch = if let Some(id) = direct_id {
47 self.builtins_by_id
48 .get(&id)
49 .filter(|entry| entry.name.as_ref() == name)
50 .map(|entry| entry.dispatch.clone())
51 } else {
52 None
53 }
54 .or_else(|| {
55 self.builtins
56 .get(name)
57 .cloned()
58 .map(VmBuiltinDispatch::Sync)
59 });
60
61 let Some(dispatch) = dispatch else {
62 if self.async_builtins.contains_key(name) || self.bridge.is_some() {
63 return None;
64 }
65 let all_builtins = self
66 .builtins
67 .keys()
68 .chain(self.async_builtins.keys())
69 .map(|s| s.as_str());
70 return Some(
71 if let Some(suggestion) = crate::value::closest_match(name, all_builtins) {
72 Err(VmError::Runtime(format!(
73 "Undefined builtin: {name} (did you mean `{suggestion}`?)"
74 )))
75 } else {
76 Err(VmError::UndefinedBuiltin(name.to_string()))
77 },
78 );
79 };
80
81 match dispatch {
82 VmBuiltinDispatch::Sync(builtin) => Some(Ok(builtin)),
83 VmBuiltinDispatch::Async(_) => None,
84 }
85 }
86
87 fn validate_sync_builtin_args(&self, name: &str, args: &[VmValue]) -> Result<(), VmError> {
88 if self.denied_builtins.contains(name) {
89 return Err(VmError::CategorizedError {
90 message: format!("Tool '{name}' is not permitted."),
91 category: ErrorCategory::ToolRejected,
92 });
93 }
94 crate::orchestration::enforce_current_policy_for_builtin(name, args)?;
95 crate::typecheck::validate_builtin_call(name, args, None)
96 }
97
98 fn index_builtin_id(&mut self, name: &str, dispatch: VmBuiltinDispatch) {
99 let id = BuiltinId::from_name(name);
100 if self.builtin_id_collisions.contains(&id) {
101 return;
102 }
103 if let Some(existing) = self.builtins_by_id.get(&id) {
104 if existing.name.as_ref() != name {
105 Arc::make_mut(&mut self.builtins_by_id).remove(&id);
106 Arc::make_mut(&mut self.builtin_id_collisions).insert(id);
107 return;
108 }
109 }
110 Arc::make_mut(&mut self.builtins_by_id).insert(
111 id,
112 VmBuiltinEntry {
113 name: std::sync::Arc::from(name),
114 dispatch,
115 },
116 );
117 }
118
119 fn refresh_builtin_id(&mut self, name: &str) {
120 if let Some(builtin) = self.builtins.get(name).cloned() {
121 self.index_builtin_id(name, VmBuiltinDispatch::Sync(builtin));
122 } else if let Some(async_builtin) = self.async_builtins.get(name).cloned() {
123 self.index_builtin_id(name, VmBuiltinDispatch::Async(async_builtin));
124 } else {
125 let id = BuiltinId::from_name(name);
126 if self
127 .builtins_by_id
128 .get(&id)
129 .is_some_and(|entry| entry.name.as_ref() == name)
130 {
131 Arc::make_mut(&mut self.builtins_by_id).remove(&id);
132 }
133 }
134 }
135
136 pub fn register_builtin<F>(&mut self, name: &str, f: F)
138 where
139 F: Fn(&[VmValue], &mut String) -> Result<VmValue, VmError> + Send + Sync + 'static,
140 {
141 Arc::make_mut(&mut self.builtins).insert(name.to_string(), Arc::new(f));
142 Arc::make_mut(&mut self.builtin_metadata)
143 .insert(name.to_string(), VmBuiltinMetadata::sync(name.to_string()));
144 self.refresh_builtin_id(name);
145 }
146
147 pub fn register_builtin_with_metadata<F>(&mut self, metadata: VmBuiltinMetadata, f: F)
149 where
150 F: Fn(&[VmValue], &mut String) -> Result<VmValue, VmError> + Send + Sync + 'static,
151 {
152 let name = metadata.name().to_string();
153 Arc::make_mut(&mut self.builtins).insert(name.clone(), Arc::new(f));
154 Arc::make_mut(&mut self.builtin_metadata)
155 .insert(name.clone(), metadata.with_kind(VmBuiltinKind::Sync));
156 self.refresh_builtin_id(&name);
157 }
158
159 pub fn register_builtin_def(&mut self, def: &'static crate::stdlib::macros::VmBuiltinDef) {
165 use crate::stdlib::macros::VmBuiltinHandler;
166 if def.parser_only {
167 return;
168 }
169 let arity = arity_from_sig(&def.sig);
173 let names = std::iter::once(def.sig.name).chain(def.aliases.iter().copied());
174 for name in names {
175 match def.handler {
176 VmBuiltinHandler::Sync(f) => {
177 let meta = builtin_def_metadata(def, name, arity, VmBuiltinKind::Sync);
178 self.register_builtin_with_metadata(meta, f);
179 }
180 VmBuiltinHandler::Async(f) => {
181 let meta = builtin_def_metadata(def, name, arity, VmBuiltinKind::Async);
182 self.register_async_builtin_with_metadata(meta, f);
186 }
187 VmBuiltinHandler::None => {
188 panic!(
191 "VmBuiltinHandler::None for {name:?} without parser_only=true \
192 on its BuiltinDef"
193 );
194 }
195 }
196 }
197 }
198
199 pub fn unregister_builtin(&mut self, name: &str) {
201 Arc::make_mut(&mut self.builtins).remove(name);
202 if self.async_builtins.contains_key(name) {
203 Arc::make_mut(&mut self.builtin_metadata).insert(
204 name.to_string(),
205 VmBuiltinMetadata::async_builtin(name.to_string()),
206 );
207 } else {
208 Arc::make_mut(&mut self.builtin_metadata).remove(name);
209 }
210 self.refresh_builtin_id(name);
211 }
212
213 pub fn register_async_builtin<F, Fut>(&mut self, name: &str, f: F)
216 where
217 F: Fn(crate::vm::AsyncBuiltinCtx, Vec<VmValue>) -> Fut + Send + Sync + 'static,
218 Fut: Future<Output = Result<VmValue, VmError>> + Send + 'static,
219 {
220 Arc::make_mut(&mut self.async_builtins).insert(
221 name.to_string(),
222 Arc::new(move |ctx, args| Box::pin(f(ctx, args))),
223 );
224 Arc::make_mut(&mut self.builtin_metadata).insert(
225 name.to_string(),
226 VmBuiltinMetadata::async_builtin(name.to_string()),
227 );
228 self.refresh_builtin_id(name);
229 }
230
231 pub fn register_async_builtin_with_metadata<F, Fut>(
234 &mut self,
235 metadata: VmBuiltinMetadata,
236 f: F,
237 ) where
238 F: Fn(crate::vm::AsyncBuiltinCtx, Vec<VmValue>) -> Fut + Send + Sync + 'static,
239 Fut: Future<Output = Result<VmValue, VmError>> + Send + 'static,
240 {
241 let name = metadata.name().to_string();
242 Arc::make_mut(&mut self.async_builtins).insert(
243 name.clone(),
244 Arc::new(move |ctx, args| Box::pin(f(ctx, args))),
245 );
246 Arc::make_mut(&mut self.builtin_metadata)
247 .insert(name.clone(), metadata.with_kind(VmBuiltinKind::Async));
248 self.refresh_builtin_id(&name);
249 }
250
251 pub(crate) fn registered_builtin_id(&self, name: &str) -> Option<BuiltinId> {
252 let id = BuiltinId::from_name(name);
253 if self
254 .builtins_by_id
255 .get(&id)
256 .is_some_and(|entry| entry.name.as_ref() == name)
257 {
258 Some(id)
259 } else {
260 None
261 }
262 }
263
264 pub(crate) async fn call_closure(
285 &mut self,
286 closure: &VmClosure,
287 args: &[VmValue],
288 ) -> Result<VmValue, VmError> {
289 self.call_closure_args(closure, CallArgs::Slice(args)).await
290 }
291
292 pub(crate) async fn call_closure_args(
293 &mut self,
294 closure: &VmClosure,
295 args: CallArgs<'_>,
296 ) -> Result<VmValue, VmError> {
297 let saved_handlers = std::mem::take(&mut self.exception_handlers);
298 let active_context = (!crate::step_runtime::is_tracked_function(&closure.func.name))
299 .then(crate::step_runtime::take_active_context);
300
301 let target_frame_depth = self.frames.len();
302 let frame_result = self.push_closure_frame_args(closure, &args);
303 drop(args);
304 let result = match frame_result {
305 Ok(()) => self.drive_until_frame_depth(target_frame_depth).await,
306 Err(e) => Err(e),
307 };
308
309 self.exception_handlers = saved_handlers;
310 if let Some(ctx) = active_context {
311 crate::step_runtime::restore_active_context(ctx);
312 }
313
314 result
315 }
316
317 pub(crate) async fn call_callable_value(
322 &mut self,
323 callable: &VmValue,
324 args: &[VmValue],
325 ) -> Result<VmValue, VmError> {
326 self.call_callable_args(callable, CallArgs::Slice(args))
327 .await
328 }
329
330 pub(crate) async fn call_callable_owned(
331 &mut self,
332 callable: &VmValue,
333 args: Vec<VmValue>,
334 ) -> Result<VmValue, VmError> {
335 self.call_callable_args(callable, CallArgs::Owned(args))
336 .await
337 }
338
339 pub(crate) async fn call_callable_zero(
340 &mut self,
341 callable: &VmValue,
342 ) -> Result<VmValue, VmError> {
343 self.call_callable_args(callable, CallArgs::Empty).await
344 }
345
346 pub(crate) async fn call_callable_one(
347 &mut self,
348 callable: &VmValue,
349 arg: &VmValue,
350 ) -> Result<VmValue, VmError> {
351 self.call_callable_args(callable, CallArgs::One(arg)).await
352 }
353
354 pub(crate) async fn call_callable_two(
355 &mut self,
356 callable: &VmValue,
357 first: &VmValue,
358 second: &VmValue,
359 ) -> Result<VmValue, VmError> {
360 self.call_callable_args(callable, CallArgs::Two(first, second))
361 .await
362 }
363
364 pub(crate) async fn call_callable_args(
365 &mut self,
366 callable: &VmValue,
367 args: CallArgs<'_>,
368 ) -> Result<VmValue, VmError> {
369 match callable {
370 VmValue::Closure(closure) => self.call_closure_args(closure, args).await,
371 VmValue::BuiltinRef(name) => {
372 if !crate::autonomy::needs_async_side_effect_enforcement(name) {
373 if let Some(result) = self.call_sync_builtin_by_ref_args(name, &args) {
374 return result;
375 }
376 }
377 self.call_named_builtin(name, args.into_vec()).await
378 }
379 VmValue::BuiltinRefId(r) => {
380 if let Some(result) =
381 self.try_call_sync_builtin_id_or_name_args(Some(r.id), &r.name, &args)
382 {
383 return result;
384 }
385 self.call_builtin_id_or_name(r.id, &r.name, args.into_vec())
386 .await
387 }
388 other => Err(VmError::TypeError(format!(
389 "expected callable, got {}",
390 other.type_name()
391 ))),
392 }
393 }
394
395 fn call_sync_builtin_by_ref_args(
396 &mut self,
397 name: &str,
398 args: &CallArgs<'_>,
399 ) -> Option<Result<VmValue, VmError>> {
400 self.try_call_sync_builtin_id_or_name_args(None, name, args)
401 }
402
403 pub(crate) fn is_callable_value(v: &VmValue) -> bool {
405 matches!(
406 v,
407 VmValue::Closure(_) | VmValue::BuiltinRef(_) | VmValue::BuiltinRefId(_)
408 )
409 }
410
411 pub async fn call_closure_pub(
414 &mut self,
415 closure: &VmClosure,
416 args: &[VmValue],
417 ) -> Result<VmValue, VmError> {
418 self.cancel_grace_instructions_remaining = None;
419 self.call_closure(closure, args).await
420 }
421
422 pub(crate) async fn call_named_builtin(
425 &mut self,
426 name: &str,
427 args: Vec<VmValue>,
428 ) -> Result<VmValue, VmError> {
429 self.call_builtin_impl(name, args, None).await
430 }
431
432 pub(crate) async fn call_builtin_id_or_name(
433 &mut self,
434 id: BuiltinId,
435 name: &str,
436 args: Vec<VmValue>,
437 ) -> Result<VmValue, VmError> {
438 self.call_builtin_impl(name, args, Some(id)).await
439 }
440
441 pub(in crate::vm) fn sync_builtin_interrupt_guard(
448 &self,
449 ) -> Option<crate::op_interrupt::OpInterruptGuard> {
450 let scope_deadline = self.deadlines.last().map(|(deadline, _)| *deadline);
453 let deadline = match (scope_deadline, self.interrupt_handler_deadline) {
454 (Some(scope), Some(interrupt)) => Some(scope.min(interrupt)),
455 (scope, interrupt) => scope.or(interrupt),
456 };
457 if self.cancel_token.is_none() && deadline.is_none() {
458 return None;
459 }
460 Some(crate::op_interrupt::install(
461 self.cancel_token.clone(),
462 deadline,
463 ))
464 }
465
466 pub(crate) fn try_call_sync_builtin_id_or_name_args(
467 &mut self,
468 direct_id: Option<BuiltinId>,
469 name: &str,
470 args: &CallArgs<'_>,
471 ) -> Option<Result<VmValue, VmError>> {
472 if self.denied_builtins.contains(name) {
473 return Some(Err(VmError::CategorizedError {
474 message: format!("Tool '{name}' is not permitted."),
475 category: ErrorCategory::ToolRejected,
476 }));
477 }
478 let builtin = match self.resolve_sync_builtin_id_or_name(direct_id, name)? {
479 Ok(builtin) => builtin,
480 Err(error) => return Some(Err(error)),
481 };
482 let _span =
483 Self::builtin_span_kind(name).map(|kind| ScopeSpan::new(kind, name.to_string()));
484 if let Err(error) = args.with_slice(|slice| self.validate_sync_builtin_args(name, slice)) {
485 return Some(Err(error));
486 }
487
488 let _interrupt = self.sync_builtin_interrupt_guard();
489 Some(args.with_slice(|slice| builtin(slice, &mut self.output)))
490 }
491
492 pub(crate) fn try_call_sync_builtin_id_or_name_from_stack_args(
493 &mut self,
494 direct_id: Option<BuiltinId>,
495 name: &str,
496 args_start: usize,
497 ) -> Option<Result<VmValue, VmError>> {
498 if self.denied_builtins.contains(name) {
499 return Some(Err(VmError::CategorizedError {
500 message: format!("Tool '{name}' is not permitted."),
501 category: ErrorCategory::ToolRejected,
502 }));
503 }
504 let builtin = match self.resolve_sync_builtin_id_or_name(direct_id, name)? {
505 Ok(builtin) => builtin,
506 Err(error) => return Some(Err(error)),
507 };
508 if args_start > self.stack.len() {
509 return Some(Err(VmError::Runtime(
510 "call argument stack underflow".to_string(),
511 )));
512 }
513
514 let _span =
515 Self::builtin_span_kind(name).map(|kind| ScopeSpan::new(kind, name.to_string()));
516 if let Err(error) = self.validate_sync_builtin_args(name, &self.stack[args_start..]) {
517 return Some(Err(error));
518 }
519
520 let _interrupt = self.sync_builtin_interrupt_guard();
521 Some(builtin(&self.stack[args_start..], &mut self.output))
522 }
523
524 async fn call_builtin_impl(
525 &mut self,
526 name: &str,
527 args: Vec<VmValue>,
528 direct_id: Option<BuiltinId>,
529 ) -> Result<VmValue, VmError> {
530 let _span =
532 Self::builtin_span_kind(name).map(|kind| ScopeSpan::new(kind, name.to_string()));
533
534 if self.denied_builtins.contains(name) {
536 return Err(VmError::CategorizedError {
537 message: format!("Tool '{name}' is not permitted."),
538 category: ErrorCategory::ToolRejected,
539 });
540 }
541 let autonomy = if crate::autonomy::needs_async_side_effect_enforcement(name) {
542 crate::autonomy::enforce_builtin_side_effect_boxed(name, &args).await?
543 } else {
544 None
545 };
546 if let Some(crate::autonomy::AutonomyDecision::Skip(value)) = autonomy {
547 return Ok(value);
548 }
549 if !matches!(
550 autonomy,
551 Some(crate::autonomy::AutonomyDecision::AllowApproved)
552 ) {
553 crate::orchestration::enforce_current_policy_for_builtin(name, &args)?;
554 }
555 crate::typecheck::validate_builtin_call(name, &args, None)?;
556
557 if let Some(result) =
558 crate::runtime_context::dispatch_runtime_context_builtin(self, name, &args)
559 {
560 return result;
561 }
562
563 if let Some(id) = direct_id {
564 if let Some(entry) = self.builtins_by_id.get(&id).cloned() {
565 if entry.name.as_ref() == name {
566 return self.call_builtin_entry(name, entry.dispatch, args).await;
567 }
568 }
569 }
570
571 if let Some(builtin) = self.builtins.get(name).cloned() {
572 self.call_builtin_entry(name, VmBuiltinDispatch::Sync(builtin), args)
573 .await
574 } else if let Some(async_builtin) = self.async_builtins.get(name).cloned() {
575 self.call_builtin_entry(name, VmBuiltinDispatch::Async(async_builtin), args)
576 .await
577 } else if let Some(bridge) = &self.bridge {
578 crate::orchestration::enforce_current_policy_for_bridge_builtin(name)?;
579 let args_json: Vec<serde_json::Value> =
580 args.iter().map(crate::llm::vm_value_to_json).collect();
581 let result = bridge
582 .call(
583 "builtin_call",
584 serde_json::json!({"name": name, "args": args_json}),
585 )
586 .await?;
587 Ok(crate::bridge::json_result_to_vm_value(&result))
588 } else {
589 let all_builtins = self
590 .builtins
591 .keys()
592 .chain(self.async_builtins.keys())
593 .map(|s| s.as_str());
594 if let Some(suggestion) = crate::value::closest_match(name, all_builtins) {
595 return Err(VmError::Runtime(format!(
596 "Undefined builtin: {name} (did you mean `{suggestion}`?)"
597 )));
598 }
599 Err(VmError::UndefinedBuiltin(name.to_string()))
600 }
601 }
602
603 async fn call_builtin_entry(
604 &mut self,
605 name: &str,
606 dispatch: VmBuiltinDispatch,
607 args: Vec<VmValue>,
608 ) -> Result<VmValue, VmError> {
609 let result = match dispatch {
610 VmBuiltinDispatch::Sync(builtin) => {
611 let _interrupt = self.sync_builtin_interrupt_guard();
612 builtin(&args, &mut self.output)
613 }
614 VmBuiltinDispatch::Async(async_builtin) => {
615 let (result, captured) =
620 crate::vm::run_async_builtin_with(self.child_vm_inline(), |ctx| {
621 async_builtin(ctx, args)
622 })
623 .await;
624 if !captured.is_empty() {
625 self.output.push_str(&captured);
626 }
627 result
628 }
629 }?;
630 if matches!(
631 name,
632 "sync_mutex_acquire"
633 | "sync_semaphore_acquire"
634 | "sync_gate_acquire"
635 | "sync_rwlock_acquire"
636 ) {
637 if let VmValue::SyncPermit(permit) = &result {
638 self.adopt_sync_permit_for_current_scope(permit.as_ref().clone());
639 }
640 }
641 Ok(result)
642 }
643}
644
645fn builtin_def_metadata(
650 def: &'static crate::stdlib::macros::VmBuiltinDef,
651 name: &'static str,
652 arity: VmBuiltinArity,
653 kind: VmBuiltinKind,
654) -> VmBuiltinMetadata {
655 let mut meta = match kind {
656 VmBuiltinKind::Sync => VmBuiltinMetadata::sync_static(name),
657 VmBuiltinKind::Async => VmBuiltinMetadata::async_static(name),
658 }
659 .arity(arity);
660 if let Some(category) = def.category {
661 meta = meta.category_static(category);
662 }
663 if let Some(doc) = def.doc {
664 meta = meta.doc_static(doc);
665 }
666 if let Some(sig_text) = def.signature_text {
667 meta = meta.signature_static(sig_text);
668 } else {
669 meta = meta.signature_owned(format!("{}", def.sig));
676 }
677 meta
678}
679
680fn arity_from_sig(sig: &harn_builtin_meta::BuiltinSignature) -> VmBuiltinArity {
685 let required = sig.params.iter().filter(|p| !p.optional).count();
686 let total = sig.params.len();
687 if sig.has_rest {
688 if required == 0 {
689 VmBuiltinArity::Variadic
690 } else {
691 VmBuiltinArity::Min(required)
692 }
693 } else if required == total {
694 VmBuiltinArity::Exact(total)
695 } else {
696 VmBuiltinArity::Range {
697 min: required,
698 max: total,
699 }
700 }
701}