miden-debug 0.7.0

An interactive debugger for Miden VM programs
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97

mod common;

use std::sync::Arc;

use miden_assembly::DefaultSourceManager;
use miden_debug::{BreakpointType, TRACE_PRINT_LN, TraceEvent, TraceMonitor};

#[test]
fn stepped_trace_println_logs_across_non_printing_steps() {
    common::init_test_debug_logger();
    let source = format!(
        r#"
begin
    # Store "hi" at element 278528
    push.26984
    push.278528
    mem_store

    # Print "hi"
    push.2
    push.1114112
    trace.{TRACE_PRINT_LN}
    drop
    drop

    # Normal instructions (no printing)
    push.1
    push.2
    add
    drop

    # Store "bye" at element 278529
    push.6650210
    push.278529
    mem_store

    # Print "bye"
    push.3
    push.1114116
    trace.{TRACE_PRINT_LN}
    drop
    drop

    # More normal instructions
    push.10
    push.20
    mul
    drop

    # Store "ok" at element 278530
    push.27503
    push.278530
    mem_store

    # Print "ok"
    push.2
    push.1114120
    trace.{TRACE_PRINT_LN}
    drop
    drop
end
"#,
    );

    let source_manager = Arc::new(DefaultSourceManager::default());
    let mut executor = common::execute_debug(&source, source_manager.clone());

    let trace_monitor = TraceMonitor::default();
    executor.register_trace_monitor_for(trace_monitor.clone(), miden_debug::TraceEvent::PrintLn);

    executor
        .step_until(
            BreakpointType::Trace(TraceEvent::PrintLn),
            Some(trace_monitor.clone()),
            &source_manager,
        )
        .unwrap();
    assert_println!("hi");

    executor
        .step_until(
            BreakpointType::Trace(TraceEvent::PrintLn),
            Some(trace_monitor.clone()),
            &source_manager,
        )
        .unwrap();
    assert_println!("bye");

    executor
        .step_until(
            BreakpointType::Trace(TraceEvent::PrintLn),
            Some(trace_monitor.clone()),
            &source_manager,
        )
        .unwrap();
    assert_println!("ok");
}