windbgr-mcp 0.1.1

MCP server for Windows debugging
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

//! cdb command-line argv assembly.
//!
//! Centralises every cdb switch we ever issue (`-p`, `-y`, `-pv`, `-g`,
//! `-o`) so that the session actor and integration tests don't have to
//! agree on the spelling separately. Also centralises the in-band REPL
//! commands (`g`, `qd`, `q`).

use std::path::Path;

use crate::error::{Error, Result};

/// Argv builder for an attach session (`cdb -p <pid>`).
pub fn attach_argv(
    pid: u32,
    noninvasive: bool,
    initial_break: bool,
    symbol_path: Option<&str>,
    extra_args: &[String],
) -> Vec<String> {
    let mut args = Vec::new();
    if noninvasive {
        args.push("-pv".into());
    }
    if !initial_break {
        args.push("-g".into());
    }
    args.push("-p".into());
    args.push(pid.to_string());
    if let Some(sp) = symbol_path {
        args.push("-y".into());
        args.push(sp.to_string());
    }
    args.extend(extra_args.iter().cloned());
    args
}

/// Argv builder for a launch session (`cdb <executable> <args...>`).
pub fn launch_argv(
    executable: &Path,
    target_args: &[String],
    debug_children: bool,
    initial_break: bool,
    symbol_path: Option<&str>,
    extra_args: &[String],
) -> Result<Vec<String>> {
    let mut args = Vec::new();
    if !initial_break {
        args.push("-g".into());
    }
    if debug_children {
        args.push("-o".into());
    }
    if let Some(sp) = symbol_path {
        args.push("-y".into());
        args.push(sp.to_string());
    }
    args.extend(extra_args.iter().cloned());
    args.push(
        executable
            .to_str()
            .ok_or_else(|| Error::other("non-utf8 executable path"))?
            .to_string(),
    );
    args.extend(target_args.iter().cloned());
    Ok(args)
}

/// In-band cdb commands (sent over stdin) used by [`crate::cdb::session`].
pub mod cmd {
    /// Continue execution.
    pub const GO: &[u8] = b"g\n";
    /// Detach from the target, leaving it running.
    pub const QUIT_DETACH: &[u8] = b"qd\n";
    /// Terminate target and debugger.
    pub const QUIT_TERMINATE: &[u8] = b"q\n";
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::path::PathBuf;

    #[test]
    fn attach_basic() {
        let argv = attach_argv(1234, false, true, None, &[]);
        assert_eq!(argv, vec!["-p", "1234"]);
    }

    #[test]
    fn attach_with_symbol_path_and_no_initial_break() {
        let argv = attach_argv(
            42,
            false,
            false,
            Some("srv*c:/sym"),
            &["-srcpath".into(), "X".into()],
        );
        assert_eq!(
            argv,
            vec!["-g", "-p", "42", "-y", "srv*c:/sym", "-srcpath", "X"]
        );
    }

    #[test]
    fn attach_noninvasive() {
        let argv = attach_argv(7, true, true, None, &[]);
        assert_eq!(argv, vec!["-pv", "-p", "7"]);
    }

    #[test]
    fn launch_with_debug_children() {
        let argv = launch_argv(
            &PathBuf::from("notepad.exe"),
            &["a.txt".into()],
            true,
            true,
            None,
            &[],
        )
        .unwrap();
        assert_eq!(argv, vec!["-o", "notepad.exe", "a.txt"]);
    }

    #[test]
    fn launch_with_no_initial_break_and_symbols() {
        let argv = launch_argv(
            &PathBuf::from("c:/x.exe"),
            &[],
            false,
            false,
            Some("srv*c:/sym"),
            &[],
        )
        .unwrap();
        assert_eq!(argv, vec!["-g", "-y", "srv*c:/sym", "c:/x.exe"]);
    }
}