调试器属性

以下 属性 用于在使用 GDB 或 WinDbg 等第三方调试器时增强调试体验。

debugger_visualizer 属性

debugger_visualizer 属性 可用于将调试器可视化文件嵌入到调试信息中。这使得在调试器中显示值时可以获得更好的调试体验。它使用 MetaListNameValueStr 语法来指定其输入，并且必须指定为包属性。

将 debugger_visualizer 与 Natvis 一起使用

Natvis 是 Microsoft 调试器（例如 Visual Studio 和 WinDbg）的基于 XML 的框架，它使用声明性规则来自定义类型的显示。有关 Natvis 格式的详细信息，请参阅 Microsoft 的 Natvis 文档。

此属性仅支持在 -windows-msvc 目标上嵌入 Natvis 文件。

Natvis 文件的路径使用 natvis_file 键指定，该键是相对于包源文件的路径

#![debugger_visualizer(natvis_file = "Rectangle.natvis")]

struct FancyRect {
    x: f32,
    y: f32,
    dx: f32,
    dy: f32,
}

fn main() {
    let fancy_rect = FancyRect { x: 10.0, y: 10.0, dx: 5.0, dy: 5.0 };
    println!("set breakpoint here");
}

并且 Rectangle.natvis 包含

<?xml version="1.0" encoding="utf-8"?>
<AutoVisualizer xmlns="http://schemas.microsoft.com/vstudio/debugger/natvis/2010">
    <Type Name="foo::FancyRect">
      <DisplayString>({x},{y}) + ({dx}, {dy})</DisplayString>
      <Expand>
        <Synthetic Name="LowerLeft">
          <DisplayString>({x}, {y})</DisplayString>
        </Synthetic>
        <Synthetic Name="UpperLeft">
          <DisplayString>({x}, {y + dy})</DisplayString>
        </Synthetic>
        <Synthetic Name="UpperRight">
          <DisplayString>({x + dx}, {y + dy})</DisplayString>
        </Synthetic>
        <Synthetic Name="LowerRight">
          <DisplayString>({x + dx}, {y})</DisplayString>
        </Synthetic>
      </Expand>
    </Type>
</AutoVisualizer>

在 WinDbg 下查看时，fancy_rect 变量将显示如下

> Variables:
  > fancy_rect: (10.0, 10.0) + (5.0, 5.0)
    > LowerLeft: (10.0, 10.0)
    > UpperLeft: (10.0, 15.0)
    > UpperRight: (15.0, 15.0)
    > LowerRight: (15.0, 10.0)

将 debugger_visualizer 与 GDB 一起使用

GDB 支持使用结构化的 Python 脚本（称为漂亮打印机），该脚本描述了如何在调试器视图中可视化类型。有关漂亮打印机的详细信息，请参阅 GDB 的 漂亮打印文档。

在 GDB 下调试二进制文件时，不会自动加载嵌入式漂亮打印机。有两种方法可以启用自动加载嵌入式漂亮打印机

1. 使用额外的参数启动 GDB，以将目录或二进制文件显式添加到自动加载安全路径：gdb -iex "add-auto-load-safe-path safe-path path/to/binary" path/to/binary 有关更多信息，请参阅 GDB 的 自动加载文档。
2. 在 $HOME/.config/gdb 下创建一个名为 gdbinit 的文件（如果该目录尚不存在，则可能需要创建该目录）。将以下行添加到该文件：add-auto-load-safe-path path/to/binary。

这些脚本使用 gdb_script_file 键嵌入，该键是相对于包源文件的路径。

#![debugger_visualizer(gdb_script_file = "printer.py")]

struct Person {
    name: String,
    age: i32,
}

fn main() {
    let bob = Person { name: String::from("Bob"), age: 10 };
    println!("set breakpoint here");
}

并且 printer.py 包含

import gdb

class PersonPrinter:
    "Print a Person"

    def __init__(self, val):
        self.val = val
        self.name = val["name"]
        self.age = int(val["age"])

    def to_string(self):
        return "{} is {} years old.".format(self.name, self.age)

def lookup(val):
    lookup_tag = val.type.tag
    if lookup_tag is None:
        return None
    if "foo::Person" == lookup_tag:
        return PersonPrinter(val)

    return None

gdb.current_objfile().pretty_printers.append(lookup)

当包的调试可执行文件传递到 GDB¹ 时，print bob 将显示

"Bob" is 10 years old.