使用 GDB 调试 Rust 应用
根据你以前对编程语言和生态系统的了解，调试可能不是你从未做过的事情，或者说是你开发过程中绝对固定的流程。
举个例子，在 Java (Kotlin 或者其他 JVM 语言) 生态系统中，由于其复杂工具的悠久历史，许多人(包括我自己)在正常的开发周期中都依赖调试器。在许多动态类型的语言中，这个工作流未被广泛的采用。
当然，这些是概括。几乎每种编程语言都具有某种调试机制，但是开发人员是否使用调试器似乎取决于工具的质量和可用性以及他们正在从事的任务。
无论如何，拥有良好的调试能力是开发过程中的关键部分。在这篇 Rust GDB 教程中，我们将会向你展示如何使用最棒的 Rust 调试工具：GNU Project Debugger (GDB) 来调试 Rust 应用程序。
我们将涵盖以下内容：
GDB 是什么
GNU Project Debugger (GDB) 是 Richard Stallman 编写的极其古老的程序，它在 1986 年自称是“GNU 项目的首席 GNUisance”。GDB 支持多种语言，例如 C/C++ 以及现代语言如 GO 和 Rust。
GDB 是一个命令行应用程序，但是有很多的 GUI 界面以及 IDE 将它进行了集成。举个例子，一个现代的，基于浏览器的实现是 gdbgui。在本篇教程中，我们将使用它的命令行界面，因为它可以在任何地方运行，不需要外部依赖，并且足够简单，可以用于我们要完成的工作。
GDB 可以运行在 Linux，MacOS 以及 Windows 中，并且大多数 Linux 的发行版预装了 GDB。你可以阅读 GDB文档以获取平台的安装说明。
GDB 十分复杂且功能强大，因此在本教程中我们不会深入探讨 GDB。我们将使用它最基本的功能，如设置断点，运行程序，逐步执行，打印变量等等。
在 Rust 中设置 GDB
为了继续本文以下内容，你需要安装最新版的 Rust (1.39+) 以及最新版的 GDB (8.x+)。可能也需要一个 TCP 包的发送工具，比如：netcat。
同样，你需要确保在rustc的同级目录中有rust-gdb可执行程序。如果你使用 Rustup 安装并更新 Rust，这应该默认就存在的。
首先，创建一个新的 Rust 项目：
cargo new rust-gdb-example
cd rust-gdb-example
接下来，编辑Cargo.toml文件并添加你需要的依赖。
[dependencies]
tokio = { version = "1.1", features=["full"] }
在这里，我们只添加 Tokio 依赖，因为我们将构建一个非常基础的异步 TCP 示例来演示我们可以像调试“普通函数”那样调试异步函数。
在src/lib.rs中添加以下代码：
#![allow(unused)] fn main() { #[derive(Clone, Debug)] pub enum AnimalType { Cat, Dog, } #[derive(Clone, Debug)] pub struct Animal { pub kind: AnimalType, pub name: String, pub age: usize, } #[derive(Clone, Debug)] pub struct Person { pub name: String, pub pets: Vec<Animal>, pub age: usize, } }
这些只是我们将在示例程序中调试的基础类型。
rust-gdb是什么？
rust-gdb是 Rust (如：使用 Rustup) 安装时附带的预构建二进制文件，且会自动安装。
基本上，rust-gdb是将外部 Python 的 pretty-printing 脚本加载到 GDB 中的封装。在调试更加复杂的 Rust 程序时将很有用(并且在一定程度上是必需的)，因为它可以显著改善 Rust 数据类型的显示。
举个例子，带有 pretty-printing 的Vec<Animal>代码如下所示：
#![allow(unused)] fn main() { Vec(size=3) = {rust_gdb_example::Animal {kind: rust_gdb_example::AnimalType::Cat, name: "Chip", age: 4}, rust_gdb_example::Animal {kind: rust_gdb_example::AnimalType::Cat, name: "Nacho", age: 6}, rust_gdb_example::Animal {kind: rust_gdb_example::AnimalType::Dog, name: "Taco", age: 2}} }
不带 pretty-printing 的代码如下所示：
#![allow(unused)] fn main() { alloc::vec::Vec<rust_gdb_example::Animal> {buf: alloc::raw_vec::RawVec<rust_gdb_example::Animal, alloc::alloc::Global> {ptr: core::ptr::unique::Unique<rust_gdb_example::Animal> {pointer: 0x5555555a1480, _marker: core::marker::PhantomData<rust_gdb_example::Animal>}, cap: 3, alloc: alloc::alloc::Global}, len: 3} }
pretty-printing 脚本为大多数广泛使用的 Rust 结构如Vec，Option，Result等提供了格式化，隐藏了它们的内部信息并展示了实际的 Rust 类型 - 这是我们在大多数时间都会感兴趣的内容。
这也是此时涉及 Rust 的调试方法的明显限制之一。如果你有复杂的嵌套的数据类型，你将需要知道它们的内部信息，或者使用某种黑魔法来正确的检查值。随着时间的流逝，这种情况会有所改善，但是从目前的情况来看，如果你使用这种方法调试复杂的实际软件，将会遇到问题。
在不进行设置的情况下，我们从一个示例程序开始，并使用它启动rust-gdb。
rust-gdb示例
让我们从一个在 Rust 中使用 GDB 的基本示例开始。
在你的项目中创建examples文件夹并添加带有以下内容的basic.rs文件：
use rust_gdb_example::*; fn main() { let animals: Vec<Animal> = vec![ Animal { kind: AnimalType::Cat, name: "Chip".to_string(), age: 4, }, Animal { kind: AnimalType::Cat, name: "Nacho".to_string(), age: 6, }, Animal { kind: AnimalType::Dog, name: "Taco".to_string(), age: 2, }, ]; get_chip(&animals); } fn get_chip(animals: &Vec<Animal>) { let chip = animals.get(0); println!("chip: {:?}", chip); }
这个非常简单的程序初始化了一个 animals 列表，并在最后调用了一个函数，该函数打印了 animals 列表中第一个元素。
为了调试这个程序，我们需要将其构建并使用rust-gdb执行构建的二进制文件。请确保使用调试模式对其进行构建而不是发布模式。
#![allow(unused)] fn main() { cargo build --example basic Finished dev [unoptimized + debuginfo] target(s) in 0.28s rust-gdb target/debug/examples/basic }
如果我们不是在构建示例，而是在构建二进制文件，二进制文件将在target/debug目录下。
在运行rust-gdb时，GDB 会打印几行欢迎信息和一个输入提示(gdb)。
如果你之前没有使用过 GDB，GDB cheat sheet 将会对你有所帮助。
我们可以通过使用break命令或缩写b来设置一个断点：
#![allow(unused)] fn main() { (gdb) b get_chip Breakpoint 1 at 0x13e3c: file examples/basic.rs, line 26. (gdb) info b Num Type Disp Enb Address What 1 breakpoint keep y 0x0000000000013e3c in basic::get_chip at examples/basic.rs:26 }
我们可以在某一行上设置断点(如：basic.rs:17)，或者在某个函数中设置断点。我们可以使用info b来查看断点，它向我们展示了断点的位置，数字(以便我们可以删除，禁用或启用它)，以及它是否被启用(Enb)。
info命令可以使用其他的选项，比如info locals，它展示了本地变量，info args，它显示了传入的函数参数以及更多的选项。
既然我们设置了断点，我们可以通过执行run(或r)来运行程序：
#![allow(unused)] fn main() { (gdb) r Starting program: /home/zupzup/dev/oss/rust/rust-gdb-example/target/debug/examples/basic [Thread debugging using libthread_db enabled] Using host libthread_db library "/lib/x86_64-linux-gnu/libthread_db.so.1". Breakpoint 1, basic::get_chip (animals=0x7fffffffd760) at examples/basic.rs:26 26 let chip = animals.get(0); }
它启动了程序。我们停在了定义的断点上，位于get_chip函数的第一行。在这里，我们可以查看函数的参数并尝试打印它们。
#![allow(unused)] fn main() { (gdb) info args animals = 0x7fffffffd760 (gdb) p animals <span class="katex"><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:0.64444em;vertical-align:0em;"></span><span class="mord">1</span><span class="mspace" style="margin-right:0.2777777777777778em;"></span><span class="mrel">=</span><span class="mspace" style="margin-right:0.2777777777777778em;"></span></span><span class="base"><span class="strut" style="height:1em;vertical-align:-0.25em;"></span><span class="mopen">(</span><span class="mord">∗</span><span class="mord mathnormal">m</span><span class="mord mathnormal">u</span><span class="mord mathnormal">t</span><span class="mord mathnormal">a</span><span class="mord mathnormal" style="margin-right:0.01968em;">ll</span><span class="mord mathnormal">oc</span><span class="mspace" style="margin-right:0.2777777777777778em;"></span><span class="mrel">::</span><span class="mspace" style="margin-right:0.2777777777777778em;"></span></span><span class="base"><span class="strut" style="height:0.43056em;vertical-align:0em;"></span><span class="mord mathnormal" style="margin-right:0.03588em;">v</span><span class="mord mathnormal">ec</span><span class="mspace" style="margin-right:0.2777777777777778em;"></span><span class="mrel">::</span><span class="mspace" style="margin-right:0.2777777777777778em;"></span></span><span class="base"><span class="strut" style="height:0.72243em;vertical-align:-0.0391em;"></span><span class="mord mathnormal" style="margin-right:0.22222em;">V</span><span class="mord mathnormal">ec</span><span class="mspace" style="margin-right:0.2777777777777778em;"></span><span class="mrel"><</span><span class="mspace" style="margin-right:0.2777777777777778em;"></span></span><span class="base"><span class="strut" style="height:0.980548em;vertical-align:-0.286108em;"></span><span class="mord mathnormal" style="margin-right:0.02778em;">r</span><span class="mord mathnormal">u</span><span class="mord mathnormal">s</span><span class="mord"><span class="mord mathnormal">t</span><span class="msupsub"><span class="vlist-t vlist-t2"><span class="vlist-r"><span class="vlist" style="height:0.15139200000000003em;"><span style="top:-2.5500000000000003em;margin-left:0em;margin-right:0.05em;"><span class="pstrut" style="height:2.7em;"></span><span class="sizing reset-size6 size3 mtight"><span class="mord mathnormal mtight" style="margin-right:0.03588em;">g</span></span></span></span><span class="vlist-s"></span></span><span class="vlist-r"><span class="vlist" style="height:0.286108em;"><span></span></span></span></span></span></span><span class="mord mathnormal">d</span><span class="mord"><span class="mord mathnormal">b</span><span class="msupsub"><span class="vlist-t vlist-t2"><span class="vlist-r"><span class="vlist" style="height:0.151392em;"><span style="top:-2.5500000000000003em;margin-left:0em;margin-right:0.05em;"><span class="pstrut" style="height:2.7em;"></span><span class="sizing reset-size6 size3 mtight"><span class="mord mathnormal mtight">e</span></span></span></span><span class="vlist-s"></span></span><span class="vlist-r"><span class="vlist" style="height:0.15em;"><span></span></span></span></span></span></span><span class="mord mathnormal">x</span><span class="mord mathnormal">am</span><span class="mord mathnormal" style="margin-right:0.01968em;">pl</span><span class="mord mathnormal">e</span><span class="mspace" style="margin-right:0.2777777777777778em;"></span><span class="mrel">::</span><span class="mspace" style="margin-right:0.2777777777777778em;"></span></span><span class="base"><span class="strut" style="height:0.73354em;vertical-align:-0.0391em;"></span><span class="mord mathnormal">A</span><span class="mord mathnormal">nima</span><span class="mord mathnormal" style="margin-right:0.01968em;">l</span><span class="mspace" style="margin-right:0.2777777777777778em;"></span><span class="mrel">></span></span><span class="base"><span class="strut" style="height:1em;vertical-align:-0.25em;"></span><span class="mclose">)</span><span class="mord">0</span><span class="mord mathnormal">x</span><span class="mord">7</span><span class="mord mathnormal">fffffffd</span><span class="mord">760</span><span class="mopen">(</span><span class="mord mathnormal" style="margin-right:0.03588em;">g</span><span class="mord mathnormal">d</span><span class="mord mathnormal">b</span><span class="mclose">)</span><span class="mord mathnormal">p</span><span class="mspace" style="margin-right:0.2222222222222222em;"></span><span class="mbin">∗</span><span class="mspace" style="margin-right:0.2222222222222222em;"></span></span><span class="base"><span class="strut" style="height:0.69444em;vertical-align:0em;"></span><span class="mord mathnormal">anima</span><span class="mord mathnormal" style="margin-right:0.01968em;">l</span><span class="mord mathnormal">s</span></span></span></span>2 = Vec(size=3) = {rust_gdb_example::Animal {kind: rust_gdb_example::AnimalType::Cat, name: "Chip", age: 4}, rust_gdb_example::Animal {kind: rust_gdb_example::AnimalType::Cat, name: "Nacho", age: 6}, rust_gdb_example::Animal {kind: rust_gdb_example::AnimalType::Dog, name: "Taco", age: 2}} }
info args命令提供了传入参数的概览。当我们使用p(print同样有用)打印 animals时，GDB 告诉我们处理的是指向Vec<Animal>的指针，但是并没有向我们展示任何有关Vec内容的信息，因为它只是一个指针。
你也可以使用display来打印变量，并且这里有很多格式的选项(如：字符串，指针，整型等)。print和display的区别是，使用display，在每次逐步执行指令之后，都会再次打印该值。这对于监控值的变更将很有用。
我们需要使用*animals来解引用指针。如果我们将其打印，我们会获得完整的，可读的 animal 列表。基础指针的戏法 (juggle) 以及类型转换是我们在引用结构体时处处需要的东西。
OK，我们现在在哪儿？让我们执行f或frame来查看我们到底在哪里：
#![allow(unused)] fn main() { (gdb) f 0 basic::get_chip (animals=0x7fffffffd760) at examples/basic.rs:26 26 let chip = animals.get(0); }
好吧，在我们设置的第一个断点那里。如果只有一种方法可以以图形化的方式来查看我们在源代码中的位置...
布局和检查状态
GDB 中的布局可以帮助你查看你处于 Rust 代码中什么位置上。使用layout src命令打开一个命令行界面：
我们的命令行提示在它的右下方。使用这种方式，我们再也不需要疑惑我们处于代码中什么位置上了。这里还有其他的布局，如layout split，它展示了代码以及相应的汇编：
看起来十分简洁。如果你想要摆脱这样的布局，你可以使用CTRL+X a。如果界面的渲染变混乱了，使用CTRL+L将会刷新界面(这会时而触发)。
与其他调试器一样，我们可以使用n或者next逐行执行代码，或者使用s或者step跳入函数内部。如果你想重复这个操作，你可以简单的按下回车键，然后上一个命令就会重复执行了。
让我们再往下执行，并在调用Vec<Animal>的.get方法查看chip变量的内部是什么：
#![allow(unused)] fn main() { (gdb) n 28 println!("chip: {:?}", chip); (gdb) p chip 3 = core::option::Option<&rust_gdb_example::Animal>::Some(0x5555555a1480) (gdb) print *(0x5555555a1480 as &rust_gdb_example::Animal) 4 = rust_gdb_example::Animal {kind: rust_gdb_example::AnimalType::Cat, name: "Chip", age: 4} }
我们执行n，现在我们处于下一行上 (28)。在这里，我们试图打印chip，然后我们看到它是一个Option类型，其中包含了一个Animal的引用。不幸的是，GDB 再一次只向我们展示了它的地址。我们需要将其转换成&rust_gdb_example::Animal，然后查看 animal 中真实的值。
一个很棒的事情就是大部分这些事情都是自动完成的。因此如果你键入rust_gd，并按下TAB键，这些都将自动完成。和AnimalType以及其他类型，函数，作用域中的变量一样。
我们也可以打印函数定义：
#![allow(unused)] fn main() { (gdb) p get_chip 11 = {fn (*mut alloc::vec::Vec<rust_gdb_example::Animal>)} 0x555555569370 <basic::get_chip> }
如果你想到这个函数的结尾处，我们可以使用finish，然后跳出并来到调用该函数的地方。如果我们使用当前的断点完成了某个调试，我们可以使用continue或者c来继续执行程序 - 在这里，将会简单的运行程序并到达它的结尾处。
#![allow(unused)] fn main() { (gdb) finish Run till exit from #0 basic::get_chip (animals=0x7fffffffd760) at examples/basic.rs:28 chip: Some(Animal { kind: Cat, name: "Chip", age: 4 }) 0x0000555555567d87 in basic::main () at examples/basic.rs:22 22 get_chip(&animals); (gdb) c Continuing. [Inferior 1 (process 61203) exited normally] }
这是不是很棒！这些都是你调试 Rust 程序的必要功能。让我们来查看另一个示例并探索更高级的技术。
操作状态和观察点
首先，让我们在examples文件夹下的nested.rs文件中创建另一个示例：
use rust_gdb_example::*; fn main() { let animals: Vec<Animal> = vec![ Animal { kind: AnimalType::Cat, name: "Chip".to_string(), age: 4, }, Animal { kind: AnimalType::Cat, name: "Nacho".to_string(), age: 6, }, Animal { kind: AnimalType::Dog, name: "Taco".to_string(), age: 2, }, ]; let mut some_person = Person { name: "Some".to_string(), pets: animals, age: 24, }; println!("person: {:?}", some_person); some_person.age = 100; some_person.name = some_func(&some_person.name); } fn some_func(name: &str) -> String { name.chars().rev().collect() }
我们再一次创建了 animal 列表。但是这一次，我们也创建了Person并将 animals 设置为他们的宠物。而且，我们会打印 person，将他们的年龄设置为100并重置他们的名字(这是 some_func 做得事情)。
在我们调试这个程序之前，我们需要再一次构建它，并使用rust-gdb执行二进制文件：
cargo build --example nested
rust-gdb target/debug/examples/nested
感觉真不错。让我们在第 22 行和第 27 行设置断点并运行该程序：
#![allow(unused)] fn main() { (gdb) b nested.rs:22 Breakpoint 1 at 0x17abf: file examples/nested.rs, line 22. (gdb) b nested.rs:27 Breakpoint 2 at 0x17b13: file examples/nested.rs, line 27. (gdb) info b Num Type Disp Enb Address What 1 breakpoint keep y 0x0000000000017abf in nested::main at examples/nested.rs:22 2 breakpoint keep y 0x0000000000017b13 in nested::main at examples/nested.rs:27 (gdb) r Starting program: /home/zupzup/dev/oss/rust/rust-gdb-example/target/debug/examples/nested [Thread debugging using libthread_db enabled] Using host libthread_db library "/lib/x86_64-linux-gnu/libthread_db.so.1". Breakpoint 1, nested::main () at examples/nested.rs:22 22 let mut some_person = Person { }
我们在第一个断点处，该位置创建了 person。让我们继续打印语句。接着，我们将在some_person.age设置所谓的观察点。这个观察点将会在some_person.age每一次改变的时候通知我们。
#![allow(unused)] fn main() { (gdb) c (gdb) watch some_person.age Hardware watchpoint 3: some_person.age (gdb) n person: Person { name: "Some", pets: [Animal { kind: Cat, name: "Chip", age: 4 }, Animal { kind: Cat, name: "Nacho", age: 6 }, Animal { kind: Dog, name: "Taco", age: 2 }], age: 24 } 28 some_person.age = 100; (gdb) n Hardware watchpoint 3: some_person.age Old value = 24 New value = 100 0x000055555556bba8 in nested::main () at examples/nested.rs:28 28 some_person.age = 100; }
GDB 向我们展示了哪一个观察点被触发，以及对应的新值和旧值。
让我们再一次通过调用run来重新运行该程序，并确认我们想要重新运行。这次，当我们来到第二个断点处时，让我们通过使用set来手动修改它的值：
#![allow(unused)] fn main() { (gdb) set some_person.age = 22 (gdb) p some_person 1 = rust_gdb_example::Person {name: "Some", pets: Vec(size=3) = {rust_gdb_example::Animal {kind: rust_gdb_example::AnimalType::Cat, name: "Chip", age: 4}, rust_gdb_example::Animal {kind: rust_gdb_example::AnimalType::Cat, name: "Nacho", age: 6}, rust_gdb_example::Animal {kind: rust_gdb_example::AnimalType::Dog, name: "Taco", age: 2}}, age: 22} }
如你所见，我们可以使用set ..args来操作我们变量的状态。这在原始类型中可以很好的工作，但是对于复杂的值，略微有些棘手 (tricky)，如 Rust 标准库 或者外部第三方的 crate 中的类型。这是另一个缺点 (drawback)，但是在将来有希望会所有改善。
另一个很棒的特性是我们可以试图执行函数并查看它们的返回值：
#![allow(unused)] fn main() { (gdb) p some_func("Hello") <span class="katex"><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:0.64444em;vertical-align:0em;"></span><span class="mord">3</span><span class="mspace" style="margin-right:0.2777777777777778em;"></span><span class="mrel">=</span><span class="mspace" style="margin-right:0.2777777777777778em;"></span></span><span class="base"><span class="strut" style="height:1.036108em;vertical-align:-0.286108em;"></span><span class="mord">"</span><span class="mord mathnormal">o</span><span class="mord mathnormal" style="margin-right:0.01968em;">ll</span><span class="mord mathnormal" style="margin-right:0.08125em;">eH</span><span class="mord">"</span><span class="mopen">(</span><span class="mord mathnormal" style="margin-right:0.03588em;">g</span><span class="mord mathnormal">d</span><span class="mord mathnormal">b</span><span class="mclose">)</span><span class="mord mathnormal">p</span><span class="mord mathnormal">so</span><span class="mord mathnormal">m</span><span class="mord"><span class="mord mathnormal">e</span><span class="msupsub"><span class="vlist-t vlist-t2"><span class="vlist-r"><span class="vlist" style="height:0.3361079999999999em;"><span style="top:-2.5500000000000003em;margin-left:0em;margin-right:0.05em;"><span class="pstrut" style="height:2.7em;"></span><span class="sizing reset-size6 size3 mtight"><span class="mord mathnormal mtight" style="margin-right:0.10764em;">f</span></span></span></span><span class="vlist-s"></span></span><span class="vlist-r"><span class="vlist" style="height:0.286108em;"><span></span></span></span></span></span></span><span class="mord mathnormal">u</span><span class="mord mathnormal">n</span><span class="mord mathnormal">c</span><span class="mopen">(</span><span class="mord">"</span><span class="mord mathnormal">De</span><span class="mord mathnormal">b</span><span class="mord mathnormal" style="margin-right:0.03588em;">ug</span><span class="mord">"</span><span class="mclose">)</span></span></span></span>4 = "gubeD" (gdb) p some_func(some_person.name) <span class="katex"><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:0.64444em;vertical-align:0em;"></span><span class="mord">5</span><span class="mspace" style="margin-right:0.2777777777777778em;"></span><span class="mrel">=</span><span class="mspace" style="margin-right:0.2777777777777778em;"></span></span><span class="base"><span class="strut" style="height:1.036108em;vertical-align:-0.286108em;"></span><span class="mord">"</span><span class="mord mathnormal">e</span><span class="mord mathnormal">m</span><span class="mord mathnormal">o</span><span class="mord mathnormal" style="margin-right:0.05764em;">S</span><span class="mord">"</span><span class="mopen">(</span><span class="mord mathnormal" style="margin-right:0.03588em;">g</span><span class="mord mathnormal">d</span><span class="mord mathnormal">b</span><span class="mclose">)</span><span class="mord mathnormal">se</span><span class="mord mathnormal">t</span><span class="mord mathnormal">so</span><span class="mord mathnormal">m</span><span class="mord"><span class="mord mathnormal">e</span><span class="msupsub"><span class="vlist-t vlist-t2"><span class="vlist-r"><span class="vlist" style="height:0.15139200000000003em;"><span style="top:-2.5500000000000003em;margin-left:0em;margin-right:0.05em;"><span class="pstrut" style="height:2.7em;"></span><span class="sizing reset-size6 size3 mtight"><span class="mord mathnormal mtight">p</span></span></span></span><span class="vlist-s"></span></span><span class="vlist-r"><span class="vlist" style="height:0.286108em;"><span></span></span></span></span></span></span><span class="mord mathnormal">erso</span><span class="mord mathnormal">n</span><span class="mord">.</span><span class="mord mathnormal">nam</span><span class="mord mathnormal">e</span><span class="mspace" style="margin-right:0.2777777777777778em;"></span><span class="mrel">=</span><span class="mspace" style="margin-right:0.2777777777777778em;"></span></span><span class="base"><span class="strut" style="height:1.036108em;vertical-align:-0.286108em;"></span><span class="mord mathnormal">so</span><span class="mord mathnormal">m</span><span class="mord"><span class="mord mathnormal">e</span><span class="msupsub"><span class="vlist-t vlist-t2"><span class="vlist-r"><span class="vlist" style="height:0.3361079999999999em;"><span style="top:-2.5500000000000003em;margin-left:0em;margin-right:0.05em;"><span class="pstrut" style="height:2.7em;"></span><span class="sizing reset-size6 size3 mtight"><span class="mord mathnormal mtight" style="margin-right:0.10764em;">f</span></span></span></span><span class="vlist-s"></span></span><span class="vlist-r"><span class="vlist" style="height:0.286108em;"><span></span></span></span></span></span></span><span class="mord mathnormal">u</span><span class="mord mathnormal">n</span><span class="mord mathnormal">c</span><span class="mopen">(</span><span class="mord mathnormal">so</span><span class="mord mathnormal">m</span><span class="mord"><span class="mord mathnormal">e</span><span class="msupsub"><span class="vlist-t vlist-t2"><span class="vlist-r"><span class="vlist" style="height:0.15139200000000003em;"><span style="top:-2.5500000000000003em;margin-left:0em;margin-right:0.05em;"><span class="pstrut" style="height:2.7em;"></span><span class="sizing reset-size6 size3 mtight"><span class="mord mathnormal mtight">p</span></span></span></span><span class="vlist-s"></span></span><span class="vlist-r"><span class="vlist" style="height:0.286108em;"><span></span></span></span></span></span></span><span class="mord mathnormal">erso</span><span class="mord mathnormal">n</span><span class="mord">.</span><span class="mord mathnormal">nam</span><span class="mord mathnormal">e</span><span class="mclose">)</span><span class="mopen">(</span><span class="mord mathnormal" style="margin-right:0.03588em;">g</span><span class="mord mathnormal">d</span><span class="mord mathnormal">b</span><span class="mclose">)</span><span class="mord mathnormal">p</span><span class="mord mathnormal">so</span><span class="mord mathnormal">m</span><span class="mord"><span class="mord mathnormal">e</span><span class="msupsub"><span class="vlist-t vlist-t2"><span class="vlist-r"><span class="vlist" style="height:0.15139200000000003em;"><span style="top:-2.5500000000000003em;margin-left:0em;margin-right:0.05em;"><span class="pstrut" style="height:2.7em;"></span><span class="sizing reset-size6 size3 mtight"><span class="mord mathnormal mtight">p</span></span></span></span><span class="vlist-s"></span></span><span class="vlist-r"><span class="vlist" style="height:0.286108em;"><span></span></span></span></span></span></span><span class="mord mathnormal">erso</span><span class="mord mathnormal">n</span></span></span></span>6 = rust_gdb_example::Person {name: "emoS", pets: Vec(size=3) = {rust_gdb_example::Animal {kind: rust_gdb_example::AnimalType::Cat, name: "Chip", age: 4}, rust_gdb_example::Animal {kind: rust_gdb_example::AnimalType::Cat, name: "Nacho", age: 6}, rust_gdb_example::Animal {kind: rust_gdb_example::AnimalType::Dog, name: "Taco", age: 2}}, age: 22} }
我们可以调用作用域内的some_func函数，它需要传入一个字面量字符串。我们可以通过some_person.name对其进行调用，并可以使用set来重置some_person.name的值。
这个功能十分强大，并且可以在调试期间影响到表达式与函数的结果，这有助于发现并解决问题。它对于解决一些简单的场景十分有用，但是如果你试图执行一个包含 I/O 或其他更复杂的操作的函数时，你可能会遇到障碍。但是对于 99% 的场景，已有的功能可以很好的完成工作。
说到 I/O，让我们查看最后一个示例：如何使用 GDB 调试 Rust 中的异步网络应用。
调试一个异步网络应用
最后同样重要的是，我们将会试图调试一个异步网络应用，运行在 tokio 异步运行时中。
让我们在examples文件夹下创建tokio.rs：
use std::io; use tokio::io::AsyncWriteExt; use tokio::net::{TcpListener, TcpStream}; #[tokio::main] async fn main() -> io::Result<()> { let listener = TcpListener::bind("127.0.0.1:8080").await?; println!("Accepting TCP on port 8080"); loop { let (socket, _) = listener.accept().await?; tokio::spawn(async move { process(socket).await }); } } async fn process(mut socket: TcpStream) { socket .write_all(b"Hello") .await .expect("can write to socket"); }
这是一个非常简单的程序，它在本地8080端口开启了一个 TCP 监听，对于每一个接入的连接，异步调用process函数来处理请求。
process函数简单的写回一个Hello，这让它其成为最简单的“网络应用”。
然而，我们在这里并不追求复杂性。相反，我们正在尝试确定在调试异步程序(如 Web 服务器)时使用 GDB 的工作流程是否发生了变化。
让我们编译这个示例并使用生成的二进制文件启动rust-gdb：
cargo build --example tokio
rust-gdb target/debug/examples/tokio
到目前为止还挺好。
让我们在第 17 行的process函数的开始部分设下一个断点：
#![allow(unused)] fn main() { (gdb) b tokio.rs:17 (gdb) info b Num Type Disp Enb Address What 1 breakpoint keep y <MULTIPLE> 1.1 y 0x000000000009aa87 in tokio::process::{{closure}} at examples/tokio.rs:17 1.2 y 0x00000000000a57fa in tokio::process at examples/tokio.rs:17 }
有趣的是，断点被分为了1.1和1.2。这在 GDB 中被称为位置。发生这种情况的原因可能是因为优化，比如内联 (inline)，举个例子，GDB 将在内联或模版化的函数中设下断点。我假设这是因为tokio::main宏，它将所有的代码都封装在了 Tokio 运行时中。
如果我们愿意，我们可以禁用每一个位置，但是在本例中这不是重点。让我们运行下这个程序：
#![allow(unused)] fn main() { (gdb) r Starting program: /home/zupzup/dev/oss/rust/rust-gdb-example/target/debug/examples/tokio [Thread debugging using libthread_db enabled] Using host libthread_db library "/lib/x86_64-linux-gnu/libthread_db.so.1". [New Thread 0x7ffff7c1e700 (LWP 55035)] [New Thread 0x7ffff7a1d700 (LWP 55036)] [New Thread 0x7ffff781c700 (LWP 55037)] [New Thread 0x7ffff761b700 (LWP 55038)] [New Thread 0x7ffff741a700 (LWP 55039)] [New Thread 0x7ffff7219700 (LWP 55040)] [New Thread 0x7ffff7018700 (LWP 55041)] [New Thread 0x7ffff6e17700 (LWP 55042)] Accepting TCP on port 8080 }
我们的监听器已经启动并正在运行，我们甚至可以看到 Tokio 运行时在后台生成的线程。
让我们使用netcat在其他终端会话中发送一些数据到这个 endpoint 中。
nc 127.0.0.1 8080
这将触发process中的断点：
#![allow(unused)] fn main() { [Switching to Thread 0x7ffff6e17700 (LWP 55041)] Thread 9 "tokio-runtime-w" hit Breakpoint 1, tokio::process::{{closure}} () at examples/tokio.rs:18 18 socket (gdb) p socket 4 = tokio::net::tcp::stream::TcpStream {io: tokio::io::poll_evented::PollEvented<mio::net::tcp::stream::TcpStream> {io: core::option::Option<mio::net::tcp::stream::TcpStream>::Some(mio::net::tcp::stream::TcpStream {inner: mio::io_source::IoSource<std::net::tcp::TcpStream> {state: mio::sys::unix::IoSourceState, inner: std::net::tcp::TcpStream (std::sys_common::net::TcpStream {inner: std::sys::unix::net::Socket (std::sys::unix::fd::FileDesc {fd: 11})}), selector_id: mio::io_source::SelectorId {id: core::sync::atomic::AtomicUsize {v: core::cell::UnsafeCell<usize> {value: 1}}}}}), registration: tokio::io::driver::registration::Registration {handle: tokio::io::driver::Handle {inner: alloc::sync::Weak<tokio::io::driver::Inner> {ptr: core::ptr::non_null::NonNull<alloc::sync::ArcInner<tokio::io::driver::Inner>> {pointer: 0x55555573a560}}}, shared: tokio::util::slab::Ref<tokio::io::driver::scheduled_io::ScheduledIo> {value: 0x55555573ec20}}}} (gdb) c }
当断点被触发，GDB 通知我们这发生在运行时生成的其中一个线程中，并且我们拥有一个socket变量，我们可以对其施加影响。
socket是一个 Tokio 的 TcpStream，但是我们并不能从打印它中了解到什么。在这里，数字11代表着一个文件修饰符，它可以打开一个网络连接，但是其余的可能是 Tokio 和 mio 的内部信息。
无论如何，它确实工作了 - 我们成功的在多线程中运行的异步处理器中设置了一个断点。这意味着如果有相同的方法同样会奏效，举个例子，一个运行的 Actix 或 warp 的 web 服务器，在其中一个处理函数中设置了一个断点，来对传入的 HTTP 请求数据施加影响。
在我们使用c继续执行后，我们第二个终端中显示了Hello的响应。
#![allow(unused)] fn main() { nc 127.0.0.1 8080 Hello }
我们使用 GDB 调试 Rust 应用程序的旅程到此结束。
你可以在 Github 获取本例的完整代码。
结论
在这篇 Rust 调试教程中，我们演示了如何使用 GDB 调试一个 Rust 应用程序。在大多数情况下，如果你要做的只是逐步执行具有断点的程序，那么它可以工作的很好，尤其是带了rust-gdb pretty-printing 扩展的程序。
当涉及更加复杂的功能时，你可能已经习惯于使用其他语言复杂的 GUI 调试器，这是一个活跃的开发领域，我希望 Rust 的调试生态系统可以得到改善。与 Java 和 C/C++ 中最好的调试器相比，Rust 将花费多长时间以及整体调试体验将有多好，这很难说，这取决于 Rust 中对此类工具的需求。
本篇教程的目的是为你提供一个工具，以最少的额外功能或必要知识来调试 Rust 程序。该背景应当涵盖你在 Rust 编程中将遇到的大多数情况.