基本概念 (GDB)

• https://www.sourceware.org/gdb/documentation/

Stack Frames

• Stack Frames 指分割调用栈 (call stack) 的连续区域
• 与一次函数调用的数据相关联：
  • 每调用一次函数，就会产生一个新的 frame¹
  • 每当函数返回，就会消除这个函数的 frame
  • 关联的数据包括：函数参数、函数内的局部变量、函数执行的地址
• 根据地址来标识 frame：每个 frame 存储了许多字节，每个字节都有各自的地址
• 函数最初执行时只有一个 frame，所以 main 函数被称作 initial frame 或者 outermost frame
• GDB 标记 frame 的规则：
  • 用数字来描述每个 frame 所处的层级，这个数字被称作 frame number 或者 frame level
  • 0 表示最内层 frame：也就是该 frame 最后执行的函数调用
  • 1 表示调用 frame 0 的 frame
  • 以此类推：frame N+1 调用 frame N
  • GDB 的命令就是使用这些数字来指定 frame
  • 函数执行的顺序与这组数字所描述的相反：对于 frame 0-N，实际按照 N-0 的顺序进行函数调用

Backtrace

• 回溯 (backtrace) 是程序如何到达某个位置的摘要：
  • 每行显示一个 frame
  • 显示多个 frames 时，从当前执行的 frame 开始（frame 0），然后是它的调用者（frame 1），然后在 stack 上堆叠起来
• 打印整个 stack 上的 frames 的命令是 backtrace （或者简写 bt）

基本命令

bt [option]… [qualifier]… [count]

例子：bt full 3 表示打印整个 stack 上的 0、1、2 frame，并且每个 frame 下显示其局部变量

(gdb) bt -full full
#0  std::sys_common::backtrace::__rust_begin_short_backtrace<fn(), ()> (f=0x55555555cc80 <hi::main>) at /rust/rust/library/std/src/sys_common/backtrace.rs:125
        result = ()
#1  0x000055555555c6f1 in std::rt::lang_start::{closure#0}<()> () at /rust/rust/library/std/src/rt.rs:145
        main = 0x55555555cc80 <hi::main>
#2  0x00005555555606ae in std::panicking::try ()
No symbol table info available.

#0 表示当前程序停止在源代码的某处，比如这里停在了 backtrace.rs 文件的第 125 行。

如果程序是使用优化编译的，而且在调用后从未使用过传递给函数的参数，那么某些编译器将优化掉这些参数。

此类优化生成通过寄存器传递参数的代码，但不会将这些参数存储在 frame 中。GDB 无法在 frame 中显示这些参数。未保存在其 frame 中的参数可能显示为 optimized out。

如果需要显示此类优化输出参数的值，请从相关变量中推断出该值，或者在不进行优化的情况下重新编译。

相关设置

视频：

• Video Tutorial: Using LLDB in iOS Part 3: Backtraces, Threads, and Frames

select

选择当前 stack 上的一个 frame，以下 f 都可以换成 frame。

基本命令

使用这些选择命令之后，会打印被选中的 frame 的两行信息。比如：

#0  hi::main () at src/main.rs:2
2           let a = vec![12];

当你不需要自动打印信息时，可以使用 select-frame、up-silentl、down-silently 来代替 f、up、down。

#0   -> innermost
...
#m-n -> down n | f m-n
...
#m-1 -> down   | f m-1

#m   -> f

#m+1 -> up
...
#m+n -> up n   | f m+n
...
#max -> outermost

查看信息

选择 frame 之后，你可以使用以下命令查看它的信息：

The command info locals -q -t type_regexp can usefully be combined with the commands frame apply and thread apply. For example, your program might use Resource Acquisition Is Initialization types (RAII) such as lock_something_t: each local variable of type lock_something_t automatically places a lock that is destroyed when the variable goes out of scope. You can then list all acquired locks in your program by doing

thread apply all -s frame apply all -s info locals -q -t lock_something_t or the equivalent shorter form

tfaas i lo -q -t lock_something_t

(gdb) f
#0  alloc::alloc::exchange_malloc (size=4, align=4) at /rust/rust/library/alloc/src/alloc.rs:320
320         match Global.allocate(layout) {

(gdb) list
315     #[cfg(all(not(no_global_oom_handling), not(test)))]
316     #[lang = "exchange_malloc"]
317     #[inline]
318     unsafe fn exchange_malloc(size: usize, align: usize) -> *mut u8 {
319         let layout = unsafe { Layout::from_size_align_unchecked(size, align) };
320         match Global.allocate(layout) {
321             Ok(ptr) => ptr.as_mut_ptr(),
322             Err(_) => handle_alloc_error(layout),
323         }
324     }

(gdb) info args
size = 4
align = 4

(gdb) info locals
layout = core::alloc::layout::Layout {size: 4, align: core::mem::valid_align::ValidAlign (core::mem::valid_align::ValidAlignEnum64::_Align1Shl2)}

(gdb) info args size
size = 4

(gdb) info locals -t Layout
layout = core::alloc::layout::Layout {size: 4, align: core::mem::valid_align::ValidAlign (core::mem::valid_align::ValidAlignEnum64::_Align1Shl2)}

(gdb) info args -t usize size
size = 4

(gdb) info f
Stack level 0, frame at 0x7fffffffe230:
 rip = 0x55555555d091 in alloc::alloc::exchange_malloc
    (/rust/rust/library/alloc/src/alloc.rs:320); saved rip = 0x55555555cc91
 called by frame at 0x7fffffffe280
 source language rust.
 Arglist at 0x7fffffffe1c8, args: size=4, align=4
 Locals at 0x7fffffffe1c8, Previous frame's sp is 0x7fffffffe230
 Saved registers:
  rip at 0x7fffffffe228

info f 包括以下内容：

• 当前 frame 的地址
• 下一个 frame 的地址（被当前 frame 调用的 frame, down）
• 上一个 frame 的地址（调用当前 frame 的 frame, up）
• 编写此 frame 的源代码的语言
• frame 参数的地址
• frame 局部变量的地址
• 调用当前 frame 时的执行地址
• frame 中保存的寄存器

基本命令

1. 关闭 gdb：quit 或者 Ctrl-d

2. 日志：

   • help set logging 查看可设置的内容及说明
   • set logging on 开启日志，将之后命令和内容输出到当前目录下的 gdb.txt 文件（默认不开启日志）

3. 运行 shell 命令：

   • 执行单条：shell command-string 或者 !command-string
   • 执行多条：
     • 默认以 | 分隔：pipe [command] | shell_command 或者 | [command] | shell_command
     • 自定义分隔符：pipe -d delim command delim shell_command 或者 | -d delim command delim shell_command

   (gdb) pipe p var|wc
     7      19      80
   (gdb) |p var|wc -l
   7
   (gdb) p /x var
   $4 = {
     black = 0x90,
     red = 0xe9,
     green = 0x179,
     blue = 0x262,
     white = 0x3db
   }
   (gdb) ||grep red
     red => 0xe9,
   (gdb) | -d ! echo this contains a | char\n ! sed -e 's/|/PIPE/'
   this contains a PIPE char
   (gdb) | -d xxx echo this contains a | char!\n xxx sed -e 's/|/PIPE/'
   this contains a PIPE char!
   

4. 重复上一个命令：回车键或者 Ctrl-o。

   • 有些命令不会被重复，比如 run
   • 对于自定义命令，使用 dont-repeat 可以让该命令不被重复
   • 对于 list 和 x 命令，重复时会构造新的参数来方便显示源代码或内存
   • # 开头的内容直到这行结束，表示注释，而不是重复
   • 按回车键进行重复可以搭配屏幕尺寸的相关设置来更方便显示长内容

5. 修改设置：

   • 全局设置：set
   • 局部设置：with setting [value] [-- command] 或者 w setting [value] [-- command]

   (GDB) set print elements 10
   (GDB) print some_array
   $1 = {0, 10, 20, 30, 40, 50, 60, 70, 80, 90...}
   
   # 有些命令支持接受参数来覆盖全局设置
   (GDB) print -elements 10 -- some_array
   $1 = {0, 10, 20, 30, 40, 50, 60, 70, 80, 90...}
   
   # with 可用于临时覆盖全局设置
   (GDB) with print array on -- print some_array
   # 等价于
   (GDB) set print array on
   (GDB) print some_array
   (GDB) set print array off
   # 可以嵌套
   (GDB) with language ada -- with print elements 10
   

6. 补全：使用 Tab 键可以补全或者提示可输入的内容。此外，如果命令是明确的，其名称可以被截断。

   • 比如 info bre TAB、info bre、inf b 与 info breakpoints 等价
   • 比如 print -object on -pretty off -element unlimited -- *myptr 与 p -o -p 0 -e u -- *myptr 等价
   • 补全设置：set max-completions limit、set max-completions unlimited、show max-completions

7. 帮助：

   • help 或者 h：查看命令的文档介绍
   • apropos [-v] regexp：从命令名称和文档介绍中，寻找符合正则内容的命令
   • complete args：从开头补全中寻找命令
   • info 或者 i：查看程序的状态，详情见 help info
   • show 或者 info set：查看 GDB 的状态（比如 show configuration 查看配置信息），详情见 help show

Checkpoint

checkpoint 保存被调试程序当前执行状态的快照。该checkpoint命令不带参数，但每个检查点都分配了一个小的整数 id，类似于断点 id。

info checkpoints
restart checkpoint-id
delete checkpoint checkpoint-id

显示程序状态

(gdb) info program
        Using the running image of child Thread 0x7ffff7d88bc0 (LWP 477478).
Program stopped at 0x55555555d347.
It stopped at breakpoint 1.
Type "info stack" or "info registers" for more information.

(gdb) info inferiors
  Num  Description       Connection           Executable
* 1    process 477478    2 (native)           /rust/tmp/hi/target/debug/hi

(gdb) info threads
  Id   Target Id                               Frame
* 1    Thread 0x7ffff7d88bc0 (LWP 477478) "hi" hi::main () at src/main.rs:2

(gdb) thread apply all bt
Thread 1 (Thread 0x7ffff7d88bc0 (LWP 477478) "hi"):
#0  hi::main () at src/main.rs:2

(gdb) thread apply 1 bt
Thread 1 (Thread 0x7ffff7d88bc0 (LWP 477478) "hi"):
#0  hi::main () at src/main.rs:2

Breakpoints

设置断点

删除和禁用

其他设置

案例

fn main() {
    let a = vec![12, 16];
    let b = f(a[0]);
    dbg!(b);
}

fn f(a: i32) -> i32 { a + 1 }

(gdb) b main
Breakpoint 1 at 0x9347: main. (2 locations)
(gdb) b f
Breakpoint 2 at 0x9605: file src/main.rs, line 7.
(gdb) b main.rs:4 if b > 0
Breakpoint 3 at 0x93f8: file src/main.rs, line 4.
(gdb) i b
Num     Type           Disp Enb Address            What
1       breakpoint     keep y   <MULTIPLE>
1.1                         y   0x0000000000009347 in hi::main at src/main.rs:2
1.2                         y   0x0000000000009640 <main>
2       breakpoint     keep y   0x0000000000009605 in hi::f at src/main.rs:7
3       breakpoint     keep y   0x00000000000093f8 in hi::main at src/main.rs:4
        stop only if b > 0
(gdb) r
Starting program: /rust/tmp/hi/target/debug/hi
[Thread debugging using libthread_db enabled]
Using host libthread_db library "/lib/x86_64-linux-gnu/libthread_db.so.1".

Breakpoint 1, 0x000055555555d640 in main ()
(gdb) c
Continuing.

Breakpoint 1, hi::main () at src/main.rs:2
2           let a = vec![12, 16];
(gdb) c
Continuing.

Breakpoint 2, hi::f (a=12) at src/main.rs:7
7       fn f(a: i32) -> i32 { a + 1 }
(gdb) c
Continuing.

Breakpoint 3, hi::main () at src/main.rs:4
4           dbg!(b);
(gdb) c
Continuing.
[src/main.rs:4] b = 13
[Inferior 1 (process 459778) exited normally]

这里由 b main 导致的多行断点只能删除整个断点 del 1，无法删除一行，但可禁用，比如 disable 1.2。

当然，也可以禁用整个断点 disable 1，或者禁用多个断点 disable 1.1 1.2。

Watchpoints

监测点是一种特殊的断点。

类型

1. 这三个命令的支持的完整参数为 watch [-l|-location] expr [thread thread-id] [mask maskvalue] [task task-id]
2. info watchpoints [list…] 或者 i b 命令可查看监测点；使用 del 或 disable 删除或禁用
3. 无法监听地址，因为地址从不被改变，如果要监听某个地址的值，需要对地址解引用
4. GDB 尽可能设置硬件所支持的监测点，因为这样执行起来很快，而且 GDB 能准确地报告修改值的指令
5. 如果使用软件监测点，那么执行起来更慢，而且在修改值的下一个语句才会报告监测点的情况
6. 只能基于作用域内的变量的表达式设置监测点，而且当执行离开定义这些变量的块时，GDB 会自动删除这些监视点
7. 更多细节参考文档：watchpoints

案例

fn main() {
   let a = vec![12, 16];
   let b = f(a[0]);
   let c = b;
   dbg!(b);
}

fn f(mut a: i32) -> i32 {
    println!("{a}");
    a += 1;
    a + 1
}

1. 监视变量

运行至某个函数内：

(gdb) b f
Breakpoint 1 at 0xa838: file src/main.rs, line 9.
(gdb) r
Starting program: /rust/tmp/hi/target/debug/hi
[Thread debugging using libthread_db enabled]
Using host libthread_db library "/lib/x86_64-linux-gnu/libthread_db.so.1".

Breakpoint 1, hi::f (a=12) at src/main.rs:9
9           println!("{a}");

方式一：使用 watch：

(gdb) watch a
Hardware watchpoint 2: a
(gdb) c
Continuing.
12

Hardware watchpoint 2: a

Old value = 12
New value = 13
hi::f (a=13) at src/main.rs:11
11          a + 1
(gdb)
Continuing.

Watchpoint 2 deleted because the program has left the block in
which its expression is valid.
0x000055555555e601 in hi::main () at src/main.rs:3
3           let b = f(a[0]);

方式二：使用 rwatch

(gdb) rwatch a
Hardware read watchpoint 3: a
(gdb) c
Continuing.

Hardware read watchpoint 3: a

Value = 12
0x0000555555590dbb in core::fmt::num::imp::<impl core::fmt::Display for i32>::fmt ()
(gdb)
Continuing.
12

Hardware read watchpoint 3: a

Value = 12
0x000055555555e890 in hi::f (a=12) at src/main.rs:10
10          a += 1;
(gdb)
Continuing.

Hardware read watchpoint 3: a

Value = 13
0x000055555555e8a9 in hi::f (a=13) at src/main.rs:11
11          a + 1
(gdb)
Continuing.

Watchpoint 3 deleted because the program has left the block in
which its expression is valid.
0x000055555555e601 in hi::main () at src/main.rs:3
3           let b = f(a[0]);

方式三：使用 awatch

(gdb) awatch a
Hardware access (read/write) watchpoint 4: a
(gdb) c
Continuing.

Hardware access (read/write) watchpoint 4: a

Value = 12
0x0000555555590dbb in core::fmt::num::imp::<impl core::fmt::Display for i32>::fmt ()
(gdb)
Continuing.
12

Hardware access (read/write) watchpoint 4: a

Value = 12
0x000055555555e890 in hi::f (a=12) at src/main.rs:10
10          a += 1;
(gdb)
Continuing.

Hardware access (read/write) watchpoint 4: a

Old value = 12
New value = 13
hi::f (a=13) at src/main.rs:11
11          a + 1
(gdb)
Continuing.

Hardware access (read/write) watchpoint 4: a

Value = 13
0x000055555555e8a9 in hi::f (a=13) at src/main.rs:11
11          a + 1
(gdb)
Continuing.

Watchpoint 4 deleted because the program has left the block in
which its expression is valid.
0x000055555555e601 in hi::main () at src/main.rs:3
3           let b = f(a[0]);

2. 监视 Vec

(gdb) start
Temporary breakpoint 1 at 0xa567: file src/main.rs, line 2.
Starting program: /rust/tmp/hi/target/debug/hi
[Thread debugging using libthread_db enabled]
Using host libthread_db library "/lib/x86_64-linux-gnu/libthread_db.so.1".

Temporary breakpoint 1, hi::main () at src/main.rs:2
2           let a = vec![12, 16];
(gdb) n
3           let b = f(a[0]);
(gdb) rwatch *a.buf.ptr.pointer.pointer@2
Hardware read watchpoint 2: *a.buf.ptr.pointer.pointer@2
(gdb) n

Hardware read watchpoint 2: *a.buf.ptr.pointer.pointer@2

Value = [12, 16]

Hardware read watchpoint 2: *a.buf.ptr.pointer.pointer@2

Value = [12, 16]
0x000055555555decc in alloc::raw_vec::RawVec<i32, alloc::alloc::Global>::ptr<i32, alloc::alloc::Global> (self=0x7fffffffe188) at /rust/rust/library/alloc/src/raw_vec.rs:225
225             self.ptr.as_ptr()

...

(gdb)
No frame is currently executing in specified block
Command aborted.
(gdb) del 2

3. 监视自定义表达式：

(gdb) watch a-12>0
Hardware watchpoint 3: a-12>0
(gdb) n
12
10          a += 1;
(gdb)

Hardware watchpoint 3: a-12>0

Old value = false
New value = true
hi::f (a=13) at src/main.rs:11
11          a + 1

Reverse

src: ReverseDebug | reversible

步骤：

1. record 或者 target record 开启记录/回放功能：
   • 必须在 run 之后使用
   • 可以在任意一处 frame 开启记录
   • 只能倒放开启之后所记录的 frame
   • record stop：结束记录，清除已执行的日志，但不终止子进程，所以可以继续正常调试
   • record delete：清除已执行的日志，并开始新的执行日志
   • set record insn-number-max：设置记录执行指令的最大个数，默认为 20W 条，0 时表示无限个数
   • set record stop-at-limit：当达到最大个数时，若为 on（这是默认行为），则停止并询问；若为 off，则清除旧记录来腾放新记录
   • info record：显示线程记录的统计信息
2. 相关命令

3. 断点和观察点都依然有效，只不过以反向顺序进行
4. 反向调试只支持部分平台