调试组件

开发软件意味着处理程序崩溃并找出 找出错误的源头Fuchsia 拥有一套工具来帮助识别和诊断 从分析崩溃日志到全面逐步说明, 调试核心代码

分析崩溃

Fuchsia 会在启动时启动一个名为 crashanalyzer 的程序,用于报告程序 崩溃,并在系统日志中输出崩溃线程的回溯。虽然 你可以在运行时查看日志、通过回溯窗口直接了解 使用堆栈内存地址引用(而非 指向程序源文件中的相应行。

[klog][I] devmgr: crash_analyzer_listener: analyzing exception type 0x108
[klog][I] <== fatal exception: process crasher[42410] thread initial-thread[42424]
[klog][I] <== fatal page fault, PC at 0x1e1888dbbbd7
[klog][I]  CS:                   0 RIP:     0x1e1888dbbbd7 EFL:            0x10246 CR2:                  0
[klog][I]  RAX:                  0 RBX:                0x1 RCX:     0x721ad98697c6 RDX:     0x77accb36f264
[klog][I]  RSI:                  0 RDI:                  0 RBP:     0x2781c4816f90 RSP:     0x2781c4816f80
[klog][I]   R8:                  0  R9:                  0 R10:                  0 R11:              0x246
[klog][I]  R12:     0x773bf11dcda0 R13:     0x773bf11dcdd0 R14:               0x16 R15:         0x78050d69
[klog][I]  errc:               0x6
[klog][I] bottom of user stack:
[klog][I] 0x00002781c4816f80: f11dcda0 0000773b 9ccd2b38 000039b2 |....;w..8+...9..|
[klog][I] 0x00002781c4816f90: c4816fd0 00002781 88dbbba7 00001e18 |.o...'..........|
[klog][I] 0x00002781c4816fa0: 00000008 00000000 9ccd2b38 000039b2 |........8+...9..|
[klog][I] 0x00002781c4816fb0: f11dcf70 0000773b f11dcf70 0000773b |p...;w..p...;w..|
[klog][I] 0x00002781c4816fc0: cb36f570 000077ac f11dcdd0 0000773b |p.6..w......;w..|
[klog][I] 0x00002781c4816fd0: c4816ff0 00002781 cb2b0d0f 000077ac |.o...'....+..w..|
[klog][I] 0x00002781c4816fe0: 00000054 00000000 f11dcf70 0000773b |T.......p...;w..|
[klog][I] 0x00002781c4816ff0: f11dcfe0 0000773b 00000000 00000000 |....;w..........|
[klog][I] arch: x86_64
[klog][I] dso: id=a94c78564173530d51670b6586b1aa471e004f06 base=0x7d3506a49000 name=libfdio.so
[klog][I] dso: id=a61961ba9776a67a00fb322af9ebbdcfd1ce3f62 base=0x77accb297000 name=libc.so
[klog][I] dso: id=760f1e6e47d3dd8b6a19150aa47241279ec75a9c base=0x721ad9863000 name=<vDSO>
[klog][I] dso: id=b18462140c6784a53736105bbf3021852eeda68c base=0x1e1888dbb000 name=app:crasher
[klog][I] bt#01: pc 0x1e1888dbbbd7 sp 0x2781c4816f80 (app:crasher,0xbd7)
[klog][I] bt#02: pc 0x1e1888dbbba7 sp 0x2781c4816fa0 (app:crasher,0xba7)
[klog][I] bt#03: pc 0x77accb2b0d0f sp 0x2781c4816fe0 (libc.so,0x19d0f)
[klog][I] bt#04: pc 0 sp 0x2781c4817000
[klog][I] bt#05: end

这是因为核心二进制文件中会剥离调试符号 默认在构建时创建为了正确分析崩溃日志,您需要 将这些符号重新应用于回溯,以便从来源的角度查看调用堆栈 代码行号。当您调用 ffx log 命令时,开发者工具会 通过另外一个名为 symbolizer 的二进制文件处理原始日志, 会将本地构建配置中的符号重新应用到 日志。

ffx log

您看到的输出包含重新应用于回溯的符号:

[klog][I] devmgr: crash_analyzer_listener: analyzing exception type 0x108
... same output as "raw" backtrace ...
start of symbolized stack:
[klog][I] #01: blind_write at ../../src/developer/forensics/crasher/cpp/crasher.c:21
[klog][I] #02: main at ../../src/developer/forensics/crasher/cpp/crasher.c:137
[klog][I] #03: start_main at ../../zircon/third_party/ulib/musl/src/env/__libc_start_main.c:49
[klog][I] #04: unknown, can't find pc, sp or app/library in line
end of symbolized stack
<ph type="x-smartling-placeholder">

通过正确符号化的回溯,您可以直接发现 导致崩溃的问题

逐步调试

仅仅知道程序崩溃的位置可能不足以全面了解 诊断问题。有时,您需要浏览代码 甚至可以逐步检查内存中变量的状态。为此, Fuchsia 提供了一个名为 zxdb 的核心代码的调试程序。

zxdb 工具是一个客户端,可连接到正在运行的 debug_agent 组件 在目标设备上的表现。您可以使用 zxdb 命令来配置 debug_agent,以附加到特定进程并设置断点。进行调试 附加到正在运行的进程,zxdb 可让您逐步完成 并检查堆栈帧。

显示 Fuchsia 调试程序 (zxdb) 如何与
在 Fuchsia 设备上运行的 debug_agent 服务用于执行交互式操作
调试进程

设置调试会话需要执行以下高级步骤:

  1. 在目标设备上运行 debug_agent 组件。
  2. 运行 zxdb 客户端并连接到目标设备。
  3. 设置 zxdb 的位置以查找调试符号。

启动调试会话的最简单方法是使用 ffx debug connect 命令,该命令将在您的本地 Fuchsia 构建环境中执行所有这些操作。 不过,如果您需要对 Google Kubernetes Engine 。

调试会话激活后,系统会将您转到 [zxdb] 提示,以便您发出 调试程序命令。您可以使用 zxdb 配置要附加的 debug_agent 调用某个进程,并设置待处理的断点,即使没有 匹配进程目前正在运行。

以下示例在 main 上设置待定断点,以在 开始执行,并等待名为“hello-world”的进程开始:

[zxdb] attach hello-world
Waiting for process matching "hello-world"

[zxdb] break main
Breakpoint 1 (Software) on Global, Enabled, stop=All, @ main
Pending: No matches for location, it will be pending library loads.
<ph type="x-smartling-placeholder">

调试程序连接到进程后,您可以使用 zxdb 命令来 控制和检查进程状态这里提供了 常用命令:

step 跳过线程中的下一行代码
next 进入线程中的下一行代码
continue 继续执行,直到下一个断点、异常或退出
frame 列出或从当前堆栈帧中选择
print 评估表达式并输出结果

练习:使用 Fuchsia 调试程序

在本练习中,您将使用 Fuchsia 调试程序 (zxdb) 检查正在运行的 echo-args 组件的实例,并了解崩溃的原因。

启动模拟器

如果您尚未运行实例,请启动模拟器:

  1. 启动新的模拟器实例:

    ffx emu start --headless
    

    启动完成后,模拟器将输出以下消息和 返回:

    Logging to "$HOME/.local/share/Fuchsia/ffx/emu/instances/fuchsia-emulator/emulator.log"
    Waiting for Fuchsia to start (up to 60 seconds)........
    Emulator is ready.
    
  2. 启动软件包服务器,使模拟器能够加载软件包:

    fx serve
    

启动调试会话

模拟器启动后,使用zxdb ffx debug connect 命令:

ffx debug connect
Connecting (use "disconnect" to cancel)...
Connected successfully.
👉 To get started, try "status" or "help".
[zxdb]

成功连接后,zxdb 提示符已准备好接受命令。

附加到组件

在启动组件之前,请将 zxdb 配置为附加到 echo-args。这样可让调试程序在进程启动后立即连接:

[zxdb] attach echo-args

greeting() 函数上设置断点:

[zxdb] break greeting

在调试程序准备就绪的情况下,启动一个新的 echo-args 组件实例:

ffx component run /core/ffx-laboratory:echo-args fuchsia-pkg://fuchsia.com/echo-args#meta/echo-args.cm

探索调试会话

到达 greeting() 中的断点时,执行会停止,调试程序 等待新命令使用 list 命令显示执行位置 当前已暂停:

Rust

[zxdb] list
  18
  19 // Return a proper greeting for the list
  20 fn greeting(names: &Vec<String>) -> String {
  21     // Join the list of names based on length
▶ 22     match names.len() {
  23         0 => String::from("Nobody"),
  24         1 => names.join(""),
  25         2 => names.join(" and "),
  26         _ => names.join(", "),
  27     }
  28 }
  29

C++

[zxdb] list
  17 
  18 // Return a proper greeting for the list
▶ 19 std::string greeting(std::vector<std::string>& names) {
  20   // Join the list of names based on length
  21   auto number_of_names = names.size();
  22   switch (number_of_names) {
  23     case 0:
  24       return "Nobody!";
  25     case 1:
  26       return join(names, "");
  27     case 2:
  28       return join(names, " and ");
  29     default:

print 命令会输出当前堆栈中所有变量的状态 帧。输出 names 的当前值:

Rust

[zxdb] print names
vec!["Alice", "Bob", "Spot"]

C++

[zxdb] print names
{"Alice", "Bob", "Spot"}

使用 next 命令单步执行几次 greeting() 函数:

[zxdb] next

如需让程序继续完成,请使用 continue 命令:

[zxdb] continue

退出调试会话以返回到终端:

[zxdb] exit

引入一些崩溃代码

接下来,您将向 src/main.rs 添加一些代码,使组件崩溃 (或恐慌)。只需添加一个 assert!(false) 宏来模拟此行为 在收集参数之后:

Rust

echo-args/src/main.rs

#[fuchsia::main(logging = true)]
async fn main() -> Result<(), anyhow::Error> {
    // ...

    // Simulate a crash 
    assert!(false, "fake crash");

    // Print a greeting to syslog
    info!("Hello, {}!", greeting(&args));

    Ok(())
}

C++

echo-args/main.cc

int main(int argc, const char* argv[], char* envp[]) {
  // ...

  // Simulate a crash 
  std::strlen(nullptr);

  // Print a greeting to syslog
  FX_LOGS(INFO) << "Hello, " << echo::greeting(arguments) << "!" << std::endl;

  return 0;
}

再次运行 fx build 以重新构建组件:

fx build

使用 zxdb 启动新的调试会话:

ffx debug connect

调试崩溃的堆栈帧

配置要附加到 echo-args 组件的调试程序:

[zxdb] attach echo-args

启动组件的新实例:

ffx component run /core/ffx-laboratory:echo-args fuchsia-pkg://fuchsia.com/echo-args#meta/echo-args.cm

这一次,调试程序检测到抛出了异常。使用 frame 命令,以检查崩溃时的堆栈轨迹:

Rust

[zxdb] frame
▶ 0 abort() • abort.c:7
  1 panic_abort::__rust_start_panic::abort() • panic_abort/src/lib.rs:43
  2 panic_abort::__rust_start_panic(…) • panic_abort/src/lib.rs:38
  3 std::panicking::rust_panic(…) • library/std/src/panicking.rs:672
  4 std::panicking::rust_panic_with_hook(…) • library/std/src/panicking.rs:642
  5 std::panicking::begin_panic::$({closure#0}<&str>)() • rust/library/std/src/panicking.rs:544
  6 std::sys_common::backtrace::$(__rust_end_short_backtrace<std::panicking::begin_panic::{closure#0}, !>)(…) • rust/library/std/src/sys_common/backtrace.rs:144
  7 std::panicking::begin_panic<…>(…) • rust/library/std/src/panicking.rs:543
  8 echo_args::main::component_entry_point::$({generator#0})(…) • main.rs:18
  9 core::future::from_generator::$({impl#1})::$(poll<echo_args::main::component_entry_point::{generator#0}>)(…) • rust/library/core/src/future/mod.rs:80
  10 core::future::future::$({impl#1})::$(poll<&mut core::future::from_generator::GenFuture<echo_args::main::component_entry_point::{generator#0}>>)(…) • future/future.rs:119
  11 futures_util::future::future::FutureExt::$(poll_unpin<core::pin::Pin<&mut core::future::from_generator::GenFuture<echo_args::main::component_entry_point::{generator#0}>>>)(…) • future/future/mod.rs:562
  12 fuchsia_async::runtime::fuchsia::executor::local::MainTask::$(poll<core::pin::Pin<&mut core::future::from_generator::GenFuture<echo_args::main::component_entry_point::{generator#0}>>>)(…) • fuchsia/src/lib/fuchsia-async/src/runtime/fuchsia/executor/local.rs:444
  13 fuchsia_async::runtime::fuchsia::executor::local::LocalExecutor::$(run_singlethreaded<core::future::from_generator::GenFuture<echo_args::main::component_entry_point::{generator#0}>>)(…) • fuchsia/src/lib/fuchsia-async/src/runtime/fuchsia/executor/local.rs:73
  14 fuchsia::$(main_singlethreaded<fuchsia::init_logging_for_component_with_executor::{closure#0}, core::future::from_generator::GenFuture<echo_args::main::component_entry_point::{generator#0}>, core::result::Result<(), anyhow::Error>>)(…) • fuchsia/src/lib/fuchsia/src/lib.rs:152
  15 echo_args::main() • main.rs:7
  16 core::ops::function::FnOnce::call_once<…>(…) • /b/s/w/ir/x/w/rust/library/core/src/ops/function.rs:227
  17 std::sys_common::backtrace::__rust_begin_short_backtrace<…>(…) • rust/library/std/src/sys_common/backtrace.rs:125
  18 std::rt::lang_start::$({closure#0}<core::result::Result<(), anyhow::Error>>)() • rust/library/std/src/rt.rs:63
  19 core::ops::function::impls::$({impl#2})::call_once<…>(…) • /b/s/w/ir/x/w/rust/library/core/src/ops/function.rs:259 (inline)
  20 std::panicking::try::do_call<…>(…) • library/std/src/panicking.rs:403 (inline)
  21 std::panicking::try<…>(…) • library/std/src/panicking.rs:367 (inline)
  22 std::panic::catch_unwind<…>(…) • library/std/src/panic.rs:129 (inline)
  23 std::rt::lang_start_internal::$({closure#2})() • library/std/src/rt.rs:45 (inline)
  24 std::panicking::try::$(do_call<std::rt::lang_start_internal::{closure#2}, isize>)(…) • library/std/src/panicking.rs:403 (inline)
  25 std::panicking::$(try<isize, std::rt::lang_start_internal::{closure#2}>)(…) • library/std/src/panicking.rs:367 (inline)
  26 std::panic::$(catch_unwind<std::rt::lang_start_internal::{closure#2}, isize>)(…) • library/std/src/panic.rs:129 (inline)
  27 std::rt::lang_start_internal(…) • library/std/src/rt.rs:45
  28 std::rt::lang_start<…>(…) • rust/library/std/src/rt.rs:62
  29 $elf(main) + 0x1f
  30 «libc startup» (-r expands)
  31 «libc startup» (-r expands)
  32 $elf(_start) + 0x11

请注意,堆栈轨迹中的第 8 行表示 src/main.rs 中 发生了崩溃,与 assert!() 宏代码行相对应。

C++

[zxdb] frame
▶ 0 strlen(…) • strlen.c:21
  1 main(…) • main.cc:27
  2 «libc startup» (-r expands)
  3 «libc startup» (-r expands)
  4 $elf(_start) + 0x11

请注意,堆栈轨迹中的第 1 行表示 main.cc 中 发生了崩溃,对应于 nullptr 引用。

当前堆栈帧(帧 0)位于系统库的深层,但 可以检查任意堆栈帧,只需在命令前添加帧号 堆栈轨迹

通过传递 帧号如下:

Rust

[zxdb] frame 8 print args
vec!["Alice", "Bob", "Spot"]

C++

[zxdb] frame 1 print arguments
{"Alice", "Bob", "Spot"}

退出调试会话以返回到终端:

[zxdb] exit

销毁实例

使用以下命令清理 echo-args 实例:

ffx component destroy /core/ffx-laboratory:echo-args