probe-rs-tools 0.31.0

A collection of on chip debugging tools to communicate with microchips.
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111

use std::fmt::Write as _;

use crate::rpc::{
    Key,
    functions::{RpcContext, RpcResult},
};
use postcard_rpc::header::VarHeader;
use postcard_schema::Schema;
use probe_rs::{Error, Session};
use probe_rs_debug::{DebugInfo, DebugRegisters, exception_handler_for_core};
use serde::{Deserialize, Serialize};

#[derive(Serialize, Deserialize, Schema)]
pub struct StackTrace {
    pub core: u32,
    pub frames: Vec<String>,
}

#[derive(Serialize, Deserialize, Schema)]
pub struct StackTraces {
    pub cores: Vec<StackTrace>,
}

#[derive(Serialize, Deserialize, Schema)]
pub struct TakeStackTraceRequest {
    pub sessid: Key<Session>,
    pub path: String,
    pub stack_frame_limit: u32,
}

pub type TakeStackTraceResponse = RpcResult<StackTraces>;

pub async fn take_stack_trace(
    ctx: &mut RpcContext,
    _header: VarHeader,
    request: TakeStackTraceRequest,
) -> TakeStackTraceResponse {
    let mut session = ctx.session(request.sessid).await;

    let Some(debug_info) = DebugInfo::from_file(&request.path).ok() else {
        Err("No debug info found.")?
    };

    session
        .halted_access(|session| {
            let mut cores = Vec::new();
            for (idx, core_type) in session.list_cores() {
                let mut core = match session.core(idx) {
                    Ok(core) => core,
                    Err(Error::CoreDisabled(_)) => continue,
                    Err(e) => return Err(e),
                };

                let initial_registers = DebugRegisters::from_core(&mut core);
                let exception_interface = exception_handler_for_core(core_type);
                let instruction_set = core.instruction_set().ok();
                let stack_frames = debug_info
                    .unwind(
                        &mut core,
                        initial_registers,
                        exception_interface.as_ref(),
                        instruction_set,
                        request.stack_frame_limit as usize,
                    )
                    .unwrap();

                let mut frame_strings = vec![];
                for (i, frame) in stack_frames.into_iter().enumerate() {
                    let mut output_stream = String::new();
                    write!(
                        &mut output_stream,
                        "Frame {}: {} @ {}",
                        i, frame.function_name, frame.pc
                    )
                    .unwrap();

                    if frame.is_inlined {
                        write!(&mut output_stream, " inline").unwrap();
                    }
                    writeln!(&mut output_stream).unwrap();

                    if let Some(location) = &frame.source_location {
                        write!(&mut output_stream, "       ").unwrap();
                        write!(&mut output_stream, "{}", location.path.to_path().display())
                            .unwrap();

                        if let Some(line) = location.line {
                            write!(&mut output_stream, ":{line}").unwrap();

                            if let Some(col) = location.column {
                                let col = match col {
                                    probe_rs_debug::ColumnType::LeftEdge => 1,
                                    probe_rs_debug::ColumnType::Column(c) => c,
                                };
                                write!(&mut output_stream, ":{col}").unwrap();
                            }
                        }
                    }

                    frame_strings.push(output_stream);
                }

                cores.push(StackTrace {
                    core: idx as u32,
                    frames: frame_strings,
                });
            }
            Ok(StackTraces { cores })
        })
        .map_err(Into::into)
}