bugstalker 0.4.5

BugStalker is a modern and lightweight debugger for rust applications.
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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346

import unittest
from helper import Debugger


class CommandTestCase(unittest.TestCase):
    def setUp(self):
        self.debugger = Debugger(path='./examples/target/debug/hello_world')

    def test_debugee_execute(self):
        """Debugee executing"""
        self.debugger.cmd('run', 'Hello, world!', 'bye!')

    def test_function_breakpoint(self):
        """Stop debugee at function by its name"""
        self.debugger.cmd('break main', 'New breakpoint')
        self.debugger.cmd('run', 'myprint("Hello, world!");')
        self.debugger.cmd('break myprint', 'New breakpoint')
        self.debugger.cmd('continue', 'Hit breakpoint 2')
        self.debugger.cmd('continue', 'Hello, world!', 'Hit breakpoint 2')
        self.debugger.cmd('continue', 'bye')

    def test_line_breakpoint(self):
        """Stop debugee at line by its number"""
        self.debugger.cmd('break hello_world.rs:15', 'New breakpoint')
        self.debugger.cmd('run', '15     println!("{}", s)')
        self.debugger.cmd('continue', 'Hello, world!', '15     println!("{}", s)')
        self.debugger.cmd('continue', 'bye!')

    def test_multiple_breakpoints_set(self):
        """Sets multiple breakpoints at line"""
        self.debugger.cmd('break hello_world.rs:5', 'New breakpoint')
        self.debugger.cmd('break hello_world.rs:9', 'New breakpoint')
        self.debugger.cmd('run', 'Hit breakpoint 1 at', 'myprint("Hello, world!")')
        self.debugger.cmd('continue', 'Hello, world!', 'Hit breakpoint 2 at', 'myprint("bye!")')
        self.debugger.cmd('continue', 'bye!')

    # maps 555555554000-55555555a000
    def test_address_breakpoint_set(self):
        """Sets breakpoints at address"""
        # determine address first
        self.debugger.cmd('break hello_world.rs:5', 'New breakpoint')
        self.debugger.cmd('run')
        addr = self.debugger.search_in_output(r'Hit breakpoint 1 at .*0x(.*):')
        addr = "0x" + addr[:14]
        self.debugger.cmd('q')
        # respawn debugger and test address breakpoint
        self.debugger = Debugger(path='./examples/target/debug/hello_world')
        self.debugger.cmd(f'break {addr}', 'New breakpoint')
        self.debugger.cmd('run', 'Hit breakpoint 1 at')
        self.debugger.cmd('continue', 'Hello, world!', 'bye!')

    def test_write_register(self):
        """Register writes (by moving pc counter into program start)"""
        # determine program start and main ret addresses first
        self.debugger.cmd('break hello_world.rs:4', 'New breakpoint')
        self.debugger.cmd('break hello_world.rs:10', 'New breakpoint')
        self.debugger.cmd('run')

        start_addr = self.debugger.search_in_output(r'Hit breakpoint 1 at .*0x(.*):')
        start_addr = "0x" + start_addr[:14]
        self.assertNotEqual(start_addr, "")
        self.debugger.cmd('continue')
        addr = self.debugger.search_in_output(r'Hit breakpoint 2 at .*0x(.*):')
        addr = "0x" + addr[:14]
        self.assertNotEqual(addr, "")
        self.debugger.cmd('q')

        # assume that address of ret instruction at 1 byte offset
        addr_as_integer = int(addr, 16) + 1
        ret_addr = hex(addr_as_integer)

        # respawn debugger and move pc counter
        self.debugger = Debugger(path='./examples/target/debug/hello_world')
        self.debugger.cmd(f'break {ret_addr}', 'New breakpoint')
        self.debugger.cmd('run', 'Hello, world!', 'bye!')
        self.debugger.cmd(f'register write rip {start_addr}')
        self.debugger.cmd('continue', 'Hello, world!', 'bye!')

    @staticmethod
    def test_step_in():
        """Debugger step in command (move to next line)"""
        debugger = Debugger(path='./examples/target/debug/calc -- 1 2 3 --description result')
        debugger.cmd('break main.rs:10', 'New breakpoint')
        debugger.cmd('run', '10     let s: i64')
        debugger.cmd('step', 'calc::sum3', '25     let ab = sum2')
        debugger.cmd('step', 'calc::sum2', '21     a + b')
        debugger.cmd('step', '22 }')
        debugger.cmd('step', 'calc::sum3', '26     sum2(ab, c)')
        debugger.cmd('step', 'calc::sum2', '21     a + b')
        debugger.cmd('step', '22 }')
        debugger.cmd('step', 'calc::sum3', '27 }')
        debugger.cmd('step', 'calc::main', '15     print(s, &args[5]);')

    def test_step_out(self):
        """Debugger step out command (move out from current function)"""
        self.debugger.cmd('break hello_world.rs:15', 'New breakpoint')
        self.debugger.cmd('run', '15     println!("{}", s)')
        self.debugger.cmd('stepout', '7     sleep(Duration::from_secs(1));')

    def test_step_over(self):
        """Debugger step over command (move to next line without
        entering functions)"""
        self.debugger.cmd('break hello_world.rs:5', 'New breakpoint')
        self.debugger.cmd('run', 'myprint("Hello, world!");')
        self.debugger.cmd('next', '7     sleep(Duration::from_secs(1));')
        self.debugger.cmd('next', '9     myprint("bye!")')
        self.debugger.cmd('next', '10 }')

    def test_step_over_on_fn_decl(self):
        """Stop debugee at function declaration line"""
        self.debugger.cmd('break hello_world.rs:14', 'New breakpoint')
        self.debugger.cmd('run', 'Hit breakpoint 1 at')
        self.debugger.cmd('next', '15     println!("{}", s)')

    def test_get_symbol(self):
        """Get debugee symbol"""
        self.debugger.cmd_re('symbol main', '__libc_start_main', r'main - Text 0x[0-9A-F]{,16}')

    def test_backtrace(self):
        """Backtrace"""
        self.debugger.cmd('break hello_world.rs:15', 'New breakpoint')
        self.debugger.cmd('run', '15     println!("{}", s)')
        self.debugger.cmd('bt', 'myprint', 'hello_world::main')

    @staticmethod
    def test_args_for_executable():
        """Run debugee with arguments"""
        debugger = Debugger(path='./examples/target/debug/calc -- 1 1 1 --description three')
        debugger.cmd('run', 'three: 3')

    @staticmethod
    def test_read_value_u64():
        """Get program variable"""
        debugger = Debugger(path='./examples/target/debug/calc -- 1 2 3 --description result')
        debugger.cmd('break main.rs:15', 'New breakpoint')
        debugger.cmd('run', '15     print(s, &args[5]);')
        debugger.cmd('var locals', 's = i64(6)')

    def test_function_breakpoint_remove(self):
        """Remove breakpoint at function by its name"""
        self.debugger.cmd('break main', 'New breakpoint')
        self.debugger.cmd('break remove main', 'Removed breakpoint')
        self.debugger.cmd('run', 'bye!')

    def test_line_breakpoint_remove(self):
        """Remove breakpoint at line by its number"""
        self.debugger.cmd('break hello_world.rs:15', 'New breakpoint')
        self.debugger.cmd('run', '15     println!("{}", s)')
        self.debugger.cmd('break remove hello_world.rs:15', 'Removed breakpoint')
        self.debugger.cmd('continue', 'bye!')

    def test_breakpoint_remove_by_number(self):
        """Remove breakpoint by its number"""
        self.debugger.cmd('break main', 'New breakpoint')
        self.debugger.cmd('break remove 1', 'Removed breakpoint')
        self.debugger.cmd('run', 'bye!')

    def test_breakpoint_info(self):
        """View breakpoints list"""
        self.debugger.cmd('break hello_world.rs:9', 'New breakpoint')
        self.debugger.cmd('break myprint', 'New breakpoint')
        self.debugger.cmd('break main', 'New breakpoint')
        self.debugger.cmd('break hello_world.rs:7', 'New breakpoint')

        self.debugger.cmd_re(
            'break info',
            r'- Breakpoint 1 at .*0x[0-9A-F]{14,16}.*: .*\/hello_world\.rs.*:9',
            r'- Breakpoint 2 at .*0x[0-9A-F]{14,16}.*: .*\/hello_world\.rs.*:15',
            r'- Breakpoint 3 at .*0x[0-9A-F]{14,16}.*: .*\/hello_world\.rs.*:5',
            r'- Breakpoint 4 at .*0x[0-9A-F]{14,16}.*: .*\/hello_world\.rs.*:7',
        )

        self.debugger.cmd('run')

        self.debugger.cmd_re(
            'break info',
            r'- Breakpoint 1 at .*0x[0-9A-F]{14,16}.*: .*\/hello_world\.rs.*:9 ',
            r'- Breakpoint 2 at .*0x[0-9A-F]{14,16}.*: .*\/hello_world\.rs.*:15',
            r'- Breakpoint 3 at .*0x[0-9A-F]{14,16}.*: .*\/hello_world\.rs.*:5',
            r'- Breakpoint 4 at .*0x[0-9A-F]{14,16}.*: .*\/hello_world\.rs.*:7',
        )

        self.debugger.cmd('break remove main', 'Removed breakpoint')

        self.debugger.cmd_re(
            'break info',
            r'- Breakpoint 1 at .*0x[0-9A-F]{14,16}.*: .*\/hello_world\.rs.*:9 ',
            r'- Breakpoint 2 at .*0x[0-9A-F]{14,16}.*: .*\/hello_world\.rs.*:15',
            r'- Breakpoint 4 at .*0x[0-9A-F]{14,16}.*: .*\/hello_world\.rs.*:7'
        )

    def test_debugee_restart(self):
        """Debugee process restart"""
        self.debugger.cmd('run', 'Hello, world!', 'bye!')
        self.debugger.cmd('run', 'Restart a program?')
        self.debugger.cmd('y', 'Hello, world!', 'bye!')

    def test_debugee_restart_at_bp(self):
        """Debugee process restarting at breakpoint"""
        self.debugger.cmd('break hello_world.rs:9', 'New breakpoint')
        self.debugger.cmd('run', 'Hello, world!')
        self.debugger.cmd('run', 'Restart a program?')
        self.debugger.cmd('y', 'Hello, world!')
        self.debugger.cmd('continue', 'bye!')

    def test_debugee_restart_at_end(self):
        """Debugee process restarting after debugee completing"""
        self.debugger.cmd('break hello_world.rs:9', 'New breakpoint')
        self.debugger.cmd('run', 'Hello, world!', 'Hit breakpoint 1')
        self.debugger.cmd('continue', 'bye!')
        self.debugger.cmd('run', 'Restart a program?')
        self.debugger.cmd('y', 'Hello, world!', 'Hit breakpoint 1')
        self.debugger.cmd('quit')

    @staticmethod
    def test_frame_switch():
        """Switch stack frame and assert argument values"""
        debugger = Debugger(path='./examples/target/debug/calc -- 1 2 3 --description result')
        debugger.cmd('break main.rs:21', 'New breakpoint 1')
        debugger.cmd('run', 'Hit breakpoint 1')
        debugger.cmd('arg all', 'a = i64(1)', 'b = i64(2)')
        debugger.cmd('frame switch 1')
        debugger.cmd('arg all', 'a = i64(1)', 'b = i64(2)', 'c = i64(3)')

    def test_disasm(self):
        """View function disassembled code"""
        self.debugger.cmd('break main', 'New breakpoint')
        self.debugger.cmd('run')
        self.debugger.cmd('source asm', 'Assembler code for function hello_world::main', 'mov')
        self.debugger.cmd('break myprint', 'New breakpoint')
        self.debugger.cmd('continue')
        self.debugger.cmd('source asm', 'Assembler code for function hello_world::myprint', 'mov')

    def test_source_fn(self):
        """View function source code"""
        self.debugger.cmd('break main', 'New breakpoint')
        self.debugger.cmd('run')
        self.debugger.cmd(
            'source fn',
            'hello_world::main at',
            '4 fn main() {',
            '7     sleep(Duration::from_secs(1));',
            '10 }'
        )

    @staticmethod
    def test_source_fn_with_frame_switch():
        """Switch stack frame and assert argument values"""
        debugger = Debugger(path='./examples/target/debug/calc -- 1 2 3 --description result')
        debugger.cmd('break main.rs:21', 'New breakpoint 1')
        debugger.cmd('run', 'Hit breakpoint 1')
        debugger.cmd(
            'source fn',
            'fn sum2(a: i64, b: i64) -> i64 {',
            'a + b',
            '}',
        )

        debugger.cmd('frame switch 1')

        debugger.cmd(
            'source fn',
            'fn sum3(a: i64, b: i64, c: i64) -> i64 {',
            'let ab = sum2(a, b);',
            'sum2(ab, c)',
            '}',
        )

        debugger.cmd('frame switch 2')

        debugger.cmd(
            'source fn',
            'fn main() {',
            'let args: Vec<String> = env::args().collect();',
            'let v1 = &args[1];',
            'let v2 = &args[2];',
            '}',
        )

    def test_source_bounds(self):
        """View source code"""
        self.debugger.cmd('break main', 'New breakpoint')
        self.debugger.cmd('run')
        self.debugger.cmd(
            'source 4',
            '1 use std::thread::sleep;',
            '4 fn main() {',
            '9     myprint("bye!")',
        )

    @staticmethod
    def test_breakpoint_at_rust_panic():
        """Set breakpoint to rust panic handler and catch panics"""
        debugger = Debugger(path='./examples/target/debug/panic -- user')
        debugger.cmd('break rust_panic', 'New breakpoint')
        debugger.cmd('run', 'then panic!')
        debugger.cmd('bt', 'rust_panic') # TODO 'panic::user_panic'
        debugger.cmd('continue')

        debugger = Debugger(path='./examples/target/debug/panic -- system')
        debugger.cmd('break rust_panic', 'New breakpoint')
        debugger.cmd('run', 'attempt to divide by zero')
        debugger.cmd('bt', 'rust_panic') # TODO 'panic::divided_by_zero'

    @staticmethod
    def test_trigger():
        """Test trigger command"""
        debugger = Debugger(path='./examples/target/debug/vars')
        debugger.cmd('trigger any')
        debugger.cmd('backtrace')
        debugger.cmd('var int8')
        debugger.cmd('end')
        debugger.cmd('break vars.rs:19', 'New breakpoint 1')
        debugger.cmd('run', 'Hit breakpoint 1', 'vars::scalar_types', 'int8 = i8(1)')

        # set trigger for a last created breakpoint
        debugger.cmd('trigger')
        debugger.cmd('var int16')
        debugger.cmd('end')
        

        debugger.cmd('trigger info', 'Any breakpoint or watchpoint', 'backtrace, var int8', 'Breakpoint 1', 'var int16')

        # remove trigger for any brkpt/wp
        debugger.cmd('trigger any')
        debugger.cmd('end')

        debugger.cmd('run')
        debugger.cmd('y', 'Hit breakpoint 1', 'int16 = i16(-1)')
        
        # set trigger for breakpoint 2
        debugger.cmd('break vars.rs:30', 'New breakpoint 2')
        debugger.cmd('trigger b 2')
        debugger.cmd('var f32')
        debugger.cmd('var f64')
        debugger.cmd('end')

        # set trigger for watchpoint 2
        debugger.cmd('watch int16', 'New watchpoint 1')
        debugger.cmd('trigger w 1')
        debugger.cmd('backtrace')
        debugger.cmd('end')

        debugger.cmd('c', 'f32 = f32(1.1)', 'f64 = f64(1.2)')
        debugger.cmd('c', 'vars::scalar_types')