miden-processor 0.24.0

Miden VM processor
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

use miden_mast_package::debug_info::PackageDebugInfo;

use crate::{
    BaseHost, ExecutionError,
    continuation_stack::{Continuation, ContinuationStack},
    errors::{
        OperationError, PackageSourceDebugContext, procedure_not_found_with_context,
        procedure_not_found_with_package_source_context,
    },
};

// HELPERS
// ---------------------------------------------------------------------------------------------

/// If the given error is generated when trying to resolve an External node, and there is a caller
/// continuation available, rebuild the error in the legacy no-context form.
///
/// In practice, `ExternalNode`s are executed via a `CallNode` or `DynNode`. Thus, if we fail to
/// resolve an `ExternalNode`, we can look at the top of the continuation stack to confirm that the
/// break came from a caller node that can lead to external node execution.
pub(super) fn maybe_use_caller_error_context<F>(
    original_err: ExecutionError,
    continuation_stack: &ContinuationStack<F>,
    package_debug_info: Option<&PackageDebugInfo>,
    host: &impl BaseHost,
) -> ExecutionError {
    if matches!(
        original_err,
        ExecutionError::ProcedureNotFound { source_file: Some(_), .. }
            | ExecutionError::OperationError { source_file: Some(_), .. }
    ) {
        return original_err;
    }

    // We only care about procedure-not-found errors or malformed MAST forest errors.
    let root_digest = match &original_err {
        ExecutionError::ProcedureNotFound { root_digest, .. } => *root_digest,
        ExecutionError::OperationError {
            err: OperationError::MalformedMastForestInHost { root_digest },
            ..
        } => *root_digest,
        _ => return original_err,
    };

    // Look for caller context in the continuation stack
    let Some((top_continuation, source_node_id)) =
        continuation_stack.peek_continuation_with_source_node_id()
    else {
        return original_err;
    };

    // Accept all continuations that can lead to external node execution.
    match top_continuation {
        Continuation::FinishCall(_)
        | Continuation::FinishJoin(_)
        | Continuation::FinishSplit(_)
        | Continuation::FinishLoop(_) => {},
        _ => return original_err,
    }

    // We found a caller continuation, so rebuild the error with caller source context when present.
    match &original_err {
        ExecutionError::ProcedureNotFound { .. } => match (package_debug_info, source_node_id) {
            (Some(debug_info), Some(source_node_id)) => {
                procedure_not_found_with_package_source_context(
                    root_digest,
                    PackageSourceDebugContext::new(debug_info, source_node_id),
                    host,
                )
            },
            _ => procedure_not_found_with_context(root_digest),
        },
        ExecutionError::OperationError { err, .. } => match (package_debug_info, source_node_id) {
            (Some(debug_info), Some(source_node_id)) => err.clone().with_package_source_context(
                PackageSourceDebugContext::new(debug_info, source_node_id),
                host,
                None,
            ),
            _ => err.clone().with_context(),
        },
        _ => original_err,
    }
}